Sphinx-PyPI-upload 0.2.1

upload_sphinx命令

upload_sphinx将创建必要的zip文件，并上传到正确的URL。

它也松散地基于Sphinx自己的setuptools命令build_sphinx，允许从命令行轻松构建文档。

upload_sphinx命令有以下选项

• --repository (-r)：仓库的URL [默认：http://pypi.python.org/pypi]

• --show-response：显示服务器完整响应文本

• --upload-dir：上传目录

示例

假设有一个名为Example的包，包含要上传到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中定义有用的默认值。以下代码片段展示了如何设置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.py upload_sphinx --upload-dir=docs/build/html