用于将Sphinx文档上传到PyPI的Setuptools命令
项目描述
此包包含一个setuptools命令,用于将Sphinx文档上传到Python包索引 (PyPI) 的专用URL packages.python.org。它是从Jannis Leidel的类似脚本派生出来的,该脚本自2009年以来未更新。
首页: https://github.com/WoLpH/sphinx-pypi-upload
upload_sphinx命令
upload_sphinx将从任意文档目录中创建必要的zip文件,并将其发布到正确的URL。
它也大致基于Sphinx自己的setuptools命令build_sphinx,该命令允许从命令行轻松构建文档。
upload_sphinx命令具有以下选项
--repository (-r):仓库URL [默认:http://pypi.python.org/pypi]
--show-response:显示来自服务器的完整响应文本
--upload-dir:上传目录
示例
假设有一个示例包,其中包含要上传到http://packages.python.org的Sphinx文档,结构如下
Example/ |-- example.py |-- setup.cfg |-- setup.py |-- docs | |-- build | | `-- html | |-- conf.py | |-- index.txt | `-- tips_tricks.txt
与任何其他基于setuptools的命令一样,您可以在Python包的setup.cfg中定义有用的默认值。以下代码片段展示了如何设置< span class="docutils literal"> build_sphinx 和 upload_sphinx setup.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.y upload_sphinx --upload-dir=docs/build/html
项目详情
关闭
Sphinx-PyPI-upload-2-0.2.2.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 2cae599a92482fbf2ba7d7a8cce13d8247de8ac3f133e73960017bcf242f369c |
|
MD5 | c52997c9dc4ac5b46a8925ff15256602 |
|
BLAKE2b-256 | a5936b2d20dafd257a41d1ff8287b7a878109c97ba52ce7da1dd0d85132a8781 |