Sphinx没有找到任何来源

Question

我正在尝试使用 sphinx 为我的项目的 python 部分生成文档。我想在 gitlab-ci 文件中执行此操作，但目前我什至无法使其在本地工作。

项目结构：

dev/

 src/

   other-src/

   python-api/

      src/

         conf.py

         index.rst

         mymodule/

           submodule1/

             some python files

           submodule2/

             some python files

           submodule3/

             some python files

           some python files

doc/

  source/

  build/

public/

我想为 dev/src/python/src/mymodule 中的所有 python 文件生成文档。然而，我所有的尝试都会导致一个空文档，我想我误解了一些东西。

我尝试遵循官方快速入门：https://www.sphinx-doc.org/en/master/usage/quickstart.html

Answer 1

听起来您没有定义 Sphinx 应考虑文档字符串中文档的哪些部分。例如，假设您有一个./docs/sourc/index.rst包含以下内容的文件：.. automodule:: python.package.path.to.class     :noindex:完成后，只需进入您的 doc 文件夹并执行以下命令：sphinx-build -b html source build