Sphinx是否可以先发出“module content”，最后发出“submodules”？

Question

我通常将Python包的高级文档放入其

文件。这对我来说是有意义的，因为

文件表示包与外部世界的接口。(说真的，你还会把它放在哪里？)

所以，当我第一次启动Sphinx时，我真的很惊讶，看到这个内容被埋在包文档的末尾，在所有子模块的内容之后。

这在我看来是倒退的。用户首先要做的就是

意志

当他访问包的页面时，他看到的是恰好按字母顺序排在第一位的子模块的文档，而他

应该

see first就在底部附近。

我想知道有没有办法解决这个问题，把这些东西放在

在子模块中的所有东西之前，先出来。如果我只是在以错误的方式来做这件事，我想知道这一点。谢谢！

Answer 1

更新答案(谢谢，Donal Fellows)：

https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html#cmdoption-sphinx-apidoc-M

原始答案：

是的，有一个选项可以做到这一点，只是没有文档记录

这里

..。在我的副本中

我发现了这个：

parser.add_option('-M', '--module-first', action='store_true',
                  dest='modulefirst',
                  help='Put module documentation before submodule '
                  'documentation')

我试过了，它就像一个护身符。

Answer 2

也可以将此选项添加到

文件。

搜索范围

属性的字符串所在的行

命令(位于try部分)并添加

选项。

新行将如下所示：

Answer 3

我已经有一段时间没有使用Sphinx了，但看起来他们确实做了很好的更新工作。在过去，我不得不手动指定类，因为我不喜欢autodoc生成方法/函数的方式。现在看起来你确实可以订购它们了：

.. autoclass:: YourClass
   :members: __init__, __getitem__

http://www.sphinx-doc.org/en/stable/ext/autodoc.html