python - 狮身人面像自动文档替换标准：成员：

Question

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

我需要

.. automodule:: main
   :members:

但具有以下功能

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

.. autodata:: CAPTION

   About my caption

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

Answer 1

从文档：

没有文档字符串的成员将被排除在外，除非您提供 undoc-members 标志选项：

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

此外，如果给出了 private-members 标志选项，则将包括“私有”成员（即命名为 _private 或 __private 的成员），如果指定-members 标志选项给出：

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

最后！可以使用常规语法覆盖显式记录的可调用对象（函数、方法、类）的签名，该语法将覆盖从内省获得的签名：

.. autoclass:: Noodle(type)

   .. automethod:: eat(persona)

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

Answer 2

当我四处寻找解决方案时，我偶然发现了这个问题。

我不确定它是否是您正在寻找的东西，但它解决了我的问题，并且它包含在此处，供任何可能觉得它有用的人使用Github HyperSpy Repo

有一个不错的小 bash 脚本，可以筛选代码并编写正确的

.. automodule

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