sphinxcontrib-argdoc 0.1.3

简介

sphinxcontrib-argdoc 是Sphinx的扩展 文档引擎。

它自动生成描述命令行参数的表 对于用python编写的可执行脚本，并插入这些表 在为脚本生成的:automodule:文档中 狮身人面像的延伸部分autodoc。

唯一的要求是：

1. The executable scripts use the Python argparse module for argument parsing.
2. The rst documentation stub file for the scripts include the ^{tt1}$ directive (which they will, by default, if you use sphinx-apidoc).

有关更多信息、详细说明和示例，请参见 sphinxcontrib-argdoc documentation。

安装和使用

sphinxcontrib-argdoc 可以从PyPI安装 使用pip。或者， 您可以将开发版本克隆到PYTHONPATH。

要使用sphinxcontrib-argdoc， 只需将sphinxcontrollib.argdoc添加到项目的扩展列表中 sphinx配置文件conf.py：

# somewhere in conf.pyextensions=['sphinxcontrib.argdoc','another_extension','some_other_extension']

测试

测试是用nose编写的， 可以在子包sphinxcontrib.argdoc.test中找到。要运行测试， 从终端输入：

$ nosetests sphinxcontrib.argdoc.test

作者

• Joshua Griffin Dunn

许可证

SphinxContrib Argdoc的许可 BSD 3-Clause License。