Sphinx autodoc替换标准:成员：

Question

所以我决定做这样的事情：

我需要

.. automodule:: main
   :members:

但具有以下功能

This is my caption
------------------

.. autodata:: CAPTION

   About my caption

所以，我需要写一些关于每个函数、方法和类的东西，但同时我还需要我在代码中创建的所有新函数都会出现在文档中，而不需要编辑文档。有可能这样做吗？

Answer 1

从docs

不包含文档字符串的成员将被忽略，除非您提供了undoc-members标志选项：

.. automodule:: noodle
   :members:
   :undoc-members:

此外，如果给出了私有成员标志选项，则将包括“私有”成员(即，那些名为_private或__private的成员)，如果给出特殊成员标志选项，则将包括Python“特殊”成员(即，名为__special__的成员)：

.. autoclass:: my.Class
   :members:
   :private-members:
   :special-members:

最后！可以使用常规语法覆盖显式记录的可调用对象(函数、方法、类)的签名，这些语法将覆盖从自省获得的签名：

.. autoclass:: Noodle(type)

   .. automethod:: eat(persona)

在我在答案开头发布的链接中有更多有用的信息。请看一下它，了解更高级的记录代码的方法。

Answer 2

当我在到处寻找一个解决方案来包含我在文档代码中的所有模块，方法，函数时，我偶然发现了这个问题。

我不确定它是否是您正在寻找的东西，但是它解决了我的问题，并将其包含在这里，以供任何可能认为它对Github HyperSpy Repo有用的人使用

我有一个很好的小bash脚本，它将筛选代码并编写适当的

.. automodule

对于源码树中的每个模块，希望这会有所帮助