Sphinx扩展,自动记录单击应用程序
sphinx-click的Python项目详细描述
sphinx click是一个Sphinx插件,允许您自动提取 来自click-based应用程序的文档,并将其包含在文档中。
安装
使用pip安装插件
$ pip install sphinx-click
或者,通过克隆此repo然后运行 setup.py:
$ python setup.py install
用法
重要
要记录基于单击的应用程序,包括应用程序本身和任何 必须安装该应用程序所需的附加依赖项。
在sphinxconf.py文件中启用插件:
extensions=['sphinx_click.ext']
一旦启用,您现在可以在 文档。
.. click:: module:parser :prog: hello-world :show-nested:
有关各种可用选项的详细信息,请参见 documentation。