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-最后是模块内容的程序包。

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

我意识到操作者在原始问题中只声明了更改的python代码，但是鉴于他后来的评论，这似乎是答案。