我正在尝试使用setuptools在pythonhosted.org
上发布文档,但是当python setup.py upload_docs
成功时,网上没有任何更改,并且我的软件包的PyPI日志中也没有报告文档更新。
然而,我仍然可以使用PyPI Web界面手动上传ZIP文件,这很好用。
我曾经使用以下方法使用MkDocs构建和部署文档:
$ mkdocs build --clean
$ python setup.py upload_docs
他们都没有报告任何错误。新网站已正确生成,可由MkDocs在本地提供。
我尝试了Python 3.4.2,3.5和3.6,以及几个版本的setuptools。我一定错过了一些明显的东西。
以下是upload_docs
命令的输出(带调试信息)。请注意,网站的内容存储在“./site”下,如检测到的那样。另请参阅我的project configuration,尤其是setup.py
和setup.cfg
。
$ python setup.py upload_docs
options (after parsing config files):
options (after parsing command line):
option dict for 'aliases' command:
{}
option dict for 'metadata' command:
{'description_file': ('setup.cfg', 'README.adoc')}
option dict for 'upload_docs' command:
{'upload_dir': ('setup.cfg', 'site')}
running upload_docs
Distribution.get_command_obj(): creating 'upload_docs' command object
setting options for 'upload_docs' command:
upload_dir = site (from setup.cfg)
Upload_docs command is deprecated. Use RTD instead.
Submitting documentation to https://pypi.python.org/pypi/
Server response (200): OK
提前感谢您的帮助。
答案 0 :(得分:1)
他们都没有报告任何错误。
技术上是正确的,但你似乎忽略了一个简单的警告。从你的输出:
不推荐使用Upload_docs命令。请改用RTD。
“已弃用”部分is clear enough:不再推荐使用此命令。
“使用RTD代替”部分不清楚,我授予您。它应该更明确:它指的是Read the Docs服务。
这是因为poorly documented as of 2017-04-05计划remove PyPI文档托管服务。