用于将sphinx文档上载到pypi的setuptools命令
Sphinx-PyPI-upload的Python项目详细描述
此包包含用于上载Sphinx的setuptools命令 到专用url的Python Package Index(pypi)的文档 packages.python.org.
upload_sphinx命令
upload_sphinx将从任意 文档目录并将其发布到正确的url。
它也松散地基于sphinx自己的setuptools命令build_sphinx 它允许从命令行轻松构建文档。
upload_sphinx命令有以下选项:
- --repository(-r): 存储库的url[默认值:http://pypi.python.org/pypi]
- --show-response: 显示服务器的完整响应文本
- --upload-dir: 要上载的目录
示例
假设有一个带有sphinx文档的Example包 已上载到http://packages.python.org,结构如下:
Example/ |-- example.py |-- setup.cfg |-- setup.py |-- docs | |-- build | | `-- html | |-- conf.py | |-- index.txt | `-- tips_tricks.txt
与任何其他基于setuptools的命令一样,可以在 python包的setup.cfg。下面的代码片段演示如何设置 build_sphinx和upload_sphinxsetup.py的选项默认值 命令:
[build_sphinx] source-dir = docs/ build-dir = docs/build all_files = 1 [upload_sphinx] upload-dir = docs/build/html
要生成和上载Sphinx文档,您现在可以运行:
$ python setup.py build_sphinx $ python setup.py upload_sphinx
或者,您当然可以直接传递适当的选项 命令:
$ python setup.py build_sphinx --source-dir=docs/ --build-dir=docs/build --all-files $ python setup.py upload_sphinx --upload-dir=docs/build/html