Sphinx local和readthedocs.org之间的区别

时间:2014-04-22 14:40:29

标签: python-sphinx

我使用DjangoSphinx应用创建了一套文档。我使用readthedocs.org创建该文档的公共版本。这很有效,但有一点奇怪。在readthedocs.org上,我的一些文档生成与本地版本不同。例如,我创建的models.py models.rst,如下所示:

Models
======

.. automodule:: my_app.models

Agents
------

Agent
`````
.. autoclass:: Agent
   :members:

etc...

对于本地构建,这将创建一个文档,其中模型名称为标题,文档字符串以及带有文档字符串的成员,其中添加了#: comment...

但是在readthedocs.org上,只会生成每个模型的标题条目,仅此而已。

似乎readthedocs.org忽略了automoduleautoclass指令。

最初我认为这是由于主题的差异造成的(我在本地使用bootstrap主题,在readthedocs上使用readthedocs.org主题),但在设置{{1}之后} virtualenv并在那里使用readthedocs.org主题,没有任何改变。构建完成,但我的模型的文档仍然不存在。

我在本地使用bootstrap。我不确定在readthedocs.org上使用的是哪个版本,但我认为它是1.2.x版本。

关于可能导致这种情况的任何想法?

1 个答案:

答案 0 :(得分:0)

同一问题困扰了我一个星期-至少就我而言,解决方案很简单:

在readthedocs.org仪表板的“高级设置”中,可以指定requirements.txt文件。在此文件中,我没有指定在某些模块中导入的PyQt5模块-添加该模块可立即解决我的问题。

对于所有这些模块,仅生成一个标题字符串,而其他所有模块都正常显示。为什么readthedocs.org上的构建过程会以无提示的方式失败,并报告构建成功,这使我心烦我还没有找到使构建过程更加冗长或检查日志文件的方法。

另请参阅Debug / logging info for build process on readthedocs.org

尤其是Sphinx automodule works offline but not through readthedocs.org下的(更好)答案