如何从代码中自动在sphinx中创建顶级文档？

Question

我有一个python包，我可以自动创建python代码中的sphinx文档

sphinx-apidoc -f -o source --full path_to_package
make html

这工作正常，html列出所有子模块及其文档。

但是在html中我看到以下部分/文字：

Package name
  Submodules
  First module
    docu...
  Second module
    docu ...

每个模块都有自己的文档，但是如何将tom文档文本直接放在包名下面？ 我想要有以下结构：

Package name
  General package documentation...
  Submodules
  First module
    docu...
  Second module
    docu ...

如何生成一个文档，以显示在sphinx生成的文档的顶层，描述整个包，只需更改python包中的代码？ 我不想更改/添加/修改sphinx生成的任何文件。

这可能吗，怎么做？

Answer 1

首先将文档作为文档字符串放在包__init__.py文件中。

然后查看包含.rst文件的docs文件夹。 编辑包的.rst - 最后包含Module内容的包.rst 。

然后剪切“模块内容”部分并将其粘贴到顶部，上面的子包中。 然后运行make html。

我意识到op声明只改变了原始问题中的python代码，但考虑到他后来的评论，这似乎就是答案。