Shibuya
sphinx-click#
sphinx-click is a Sphinx plugin that allows you to automatically extract documentation from a click-based application and include it in your docs.
Documentation: https://sphinx-click.readthedocs.io/
Source Code: https://github.com/click-contrib/sphinx-click
Usage#
Install sphinx-click:
pip install sphinx-click
Add sphinx_click to your conf.py:
extensions = [
'sphinx_click',
]
Example#
.. click:: click_demo:greet
:prog: greet
:nested: full
greet#
A sample command group.
Usage
greet [OPTIONS] COMMAND [ARGS]...
hello#
Greet a user.
Usage
greet hello [OPTIONS] USER
Arguments
- USER#
Required argument
Environment variables
- USER
Provide a default for
USER
world#
Greet the world.
Usage
greet world [OPTIONS]