狮身人面像
项目描述
介绍
sphinxcontrib-argdoc 是Sphinx 文档引擎的扩展。
它会自动为用 Python 编写的可执行脚本生成描述命令行参数的表格，并将这些表格插入到:automodule:由 Sphinx 扩展autodoc为脚本生成的文档中。
唯一的要求是：
可执行脚本使用 Python argparse模块进行参数解析。
脚本的第一个文档存根文件包括:automodule:指令（默认情况下，如果您使用sphinx-apidoc ，它们将使用该指令）。
有关更多信息、详细说明和示例，请参阅 sphinxcontrib-argdoc 文档。
安装使用
sphinxcontrib-argdoc 可以 使用pip从PyPI安装。或者，您可以将开发版本克隆到您的PYTHONPATH中。
要使用sphinxcontrib-argdoc，只需将“sphinxcontrib.argdoc”添加到项目的 Sphinx 配置文件conf.py的扩展列表中：
# somewhere in conf.py extensions = ['sphinxcontrib.argdoc', 'another_extension', 'some_other_extension' ]
测试
测试是使用nose编写的，可以在子包sphinxcontrib.argdoc.test中找到。要运行测试，请从终端键入：
$ nosetests sphinxcontrib.argdoc.test
执照
sphinxcontrib-argdoc根据 BSD 3-Clause License 获得许可。
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
sphinxcontrib-argdoc-0.1.3.tar.gz
(22.9 kB
查看哈希)
内置分布
关
sphinxcontrib -argdoc-0.1.3.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | a062b96bca3c1cb9b2c4cfeed09dd4d78d32ea8ddb2c38769df22671a2c78439 |
|
| MD5 | cc0837696f6f264de602a4f8566be083 |
|
| 布莱克2-256 | 22a7e167af1c16d0640ac41a0d45d443307271c346ea9bccba1897809a74e87e |
关
sphinxcontrib_argdoc -0.1.3-py2.py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 13485163bbaca777eb58fd53e2948531ffc4b71221b91644db889ab552724be7 |
|
| MD5 | b14a7763a6cc1a13ba16843484f41ab3 |
|
| 布莱克2-256 | b89efad1332271473652d7702dfc89f76017cb6ef854581b3582c0ecdfe79f07 |