如何從代碼中自動在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代碼，但考慮到他后來的評論，這似乎就是答案。