Sphinx 文档 (autodoc) 在上传到 Github 后无法使用

Question

我已经为我的包构建了 sphinx 文档。 测试 localhost 时它工作正常。但是在将其上传到 Github 并在 readthedocs.org 上构建文档后，使用 autodoc 的文档页面无法正常工作。 这是 link 到 Github 存储库。

https://github.com/SparkDrago05/quick_sqlite

这是文档的 link。

https://quick-sqlite.readthedocs.io/en/latest/index.html

任何帮助将不胜感激！

Answer 1

在您的 log file 中，它表示 WARNING: autodoc: failed to import class 'QuickSqlite' from module 'quick_sqlite'; the following exception was raised: No module named 'quick_sqlite'

您需要告诉 RTD 安装您的模块。参见：https://docs.readthedocs.io/en/stable/tutorial/index.html#making-warnings-more-visible

The reason sphinx.ext.autosummary and sphinx.ext.autodoc fail to import the code is because it is not installed. Luckily, the .readthedocs.yaml also allows you to specify which requirements to install.

.readthedocs.yaml

python:
  # Install our python package before building the docs
  install:
    - method: pip
      path: .