Arr*_*erg 5 python-sphinx read-the-docs
我有开源我的一些代码,但文档将无法正确ReadTheDocs尽管预期与Makefile文件创建通过努力建立sphinx-quickstart和make html本地。任何人都可以就我在 RTD 集成方面做错了什么提出建议吗?
我已经阅读了有关可能使用 RTD 高级设置在 virtualenv 中构建模块的信息,但这不起作用,因为我有 scipy 作为要求,并且由于没有可用的 BLAS 库而导致构建失败(对于每个构建来说,这也是一项不必要的冗长任务的文档)。
sphinx.ext.autodoc 和 sphinx.ext.napoleon(用于 Google 风格的文档字符串)都包括在内。本地我只是跑dev-scripts/api-docs.sh这一次创建docs/source/bnol.rst和docs/source/modules.rst。然后使用标准的 Makefile(在 git repo 中忽略)按预期构建文档。
/bnol/编辑:我发现这个FAQ 详细说明了 RTD 上的构建过程,并在sphinx-build本地使用了相同的过程,它按预期工作。我正在搜索 RTD 日志以查找错误,但目前还没有什么值得注意的。
使用 Sphinx 的autodoc从文档字符串注释创建文档需要加载 Python 文件,因此它们导入的所有模块也将被导入。numpyReadTheDocs 将构建所需的模块,特别是在和的情况下scipy,可能会失败。
我通过删除模块setup.py并将它们列在包根目录中的pip需求文件中以供实际包安装使用来纠正该问题。./requirements.txt然后放置一个虚拟(空)需求文件,./docs/source/并将 ReadTheDocs 配置指向那里(即使未指定,它似乎也会自动加载./requirements.txt,因此需要虚拟文件)。
这仍然存在导入模块的问题,该问题已mock在我的./docs/source/conf.py文件中看到并在以下位置详细说明:
http://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when -您正在使用 numpy 和 scipy/
可以在解决问题的提交中看到完整的更改列表。