python - Sphinx autodoc 替换标准 :members:

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)”成员(即那些命名为 _private 或 __private 的成员)将被包括在内，并且 Python“特殊”成员(即那些命名为 __special__ 的成员)将被包括在内如果给出了特殊成员标志选项:

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

最后!可以使用常规语法覆盖显式记录的可调用对象(函数、方法、类)的签名，该语法将覆盖从内省(introspection)获得的签名:

.. autoclass:: Noodle(type)

   .. automethod:: eat(persona)

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