Sphinx autodoc替换标准:members:

Question

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

我需要

.. automodule:: main
   :members:

但具有

的功能

This is my caption
------------------
.. autodata:: CAPTION
   About my caption

所以，我需要写一些关于每个函数，方法和类的东西，但除此之外，我需要我在代码中创建的所有新函数都将出现在文档中，而无需编辑文档。有可能做到吗?

Answer 1

From the docs:

没有文档字符串的成员将被忽略，除非你给出了undoc-members标志选项:

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

同样，如果给出了Private -members标志选项，将包含"Private"成员(即像_private或__private那样命名的成员);如果给出了special-members标志选项，将包含Python的"特殊"成员(即像__special__那样命名的成员):

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

最后!对于显式记录的可调用对象(函数、方法、类)，可以使用常规语法重写从自省获得的签名:

.. autoclass:: Noodle(type)
   .. automethod:: eat(persona)

有很多有用的信息在我张贴在答案的开头的链接。查看它，了解更多编写代码的高级方法。

Answer 2

当我在寻找一个解决方案，包括所有的模块，方法，函数，我在代码的文档我无意中发现了这个问题。

我不确定它是否是你正在寻找的，但它解决了我的问题，它包含在这里的任何人谁可能会发现它有用的Github HyperSpy Repo

有一个不错的bash脚本，它将筛选代码并编写适当的

.. automodule

在你的源代码树的每个模块，希望有帮助