小编Arr*_*erg的帖子

ReadTheDocs 不解析 Python 模块中的文档字符串 (Sphinx)

我有开源我的一些代码,但文档将无法正确ReadTheDocs尽管预期与Makefile文件创建通过努力建立sphinx-quickstartmake html本地。任何人都可以就我在 RTD 集成方面做错了什么提出建议吗?

我已经阅读了有关可能使用 RTD 高级设置在 virtualenv 中构建模块的信息,但这不起作用,因为我有 scipy 作为要求,并且由于没有可用的 BLAS 库而导致构建失败(对于每个构建来说,这也是一项不必要的冗长任务的文档)。

sphinx.ext.autodoc 和 sphinx.ext.napoleon(用于 Google 风格的文档字符串)都包括在内。本地我只是跑dev-scripts/api-docs.sh这一次创建docs/source/bnol.rstdocs/source/modules.rst。然后使用标准的 Makefile(在 git repo 中忽略)按预期构建文档。

编辑:我发现这个FAQ 详细说明了 RTD 上的构建过程,并在sphinx-build本地使用了相同的过程,它按预期工作。我正在搜索 RTD 日志以查找错误,但目前还没有什么值得注意的。

python-sphinx read-the-docs

5
推荐指数
1
解决办法
1840
查看次数

标签 统计

python-sphinx ×1

read-the-docs ×1