python - 如何使用 Sphinx 记录特定部分中的成员？

Question

我正在努力弄清楚如何将 Python 类的特定成员的文档放置在 Sphinx 文档的特定部分中，最好同时将其余部分自动记录在另一个部分中。

我有一个Python类

class MyClass(object):

    def funky(self, arg):
        """Some docs."""
        ...

在 my/module.py 中定义，它按预期工作，我可以使用它来记录而不会出现问题

***************************
MyModule - :mod:`my.module`
***************************

.. automodule:: my.module

.. autoclass:: MyClass
   :members:
   :undoc-members:
   :show-inheritance:

但是当我尝试更好地控制文档的组织时，我无法让事情正常进行。具体来说，我希望将一些成员记录在明确的部分中(此处仅显示一个成员，但会有多个)，其余成员作为一个组自动记录。

但是当我尝试这个时，例如

***************************
MyModule - :mod:`my.module`
***************************

To document
===========

Things that are not yet documented.

.. automodule:: my.module

.. autoclass:: MyClass
   :members:
   :undoc-members:
   :show-inheritance:
   :exclude-members: funky

Funky things
------------

Some funky things.

.. automethod:: funky

我明白

WARNING: don't know which module to import for autodocumenting u'funky' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)

但没有变化

.. currentmodule:: my.module
.. class:: MyClass

.. automethod:: funky

或

.. currentmodule:: my.module

   .. automethod:: funky

等等。带我去任何地方。

如何在 Sphinx 文档的特定位置自动记录类(class)的某些成员？

Answer 1

这有效:

.. currentmodule:: my.module

.. automethod:: MyClass.funky

您可以跳过 .. currentmodule:: 并按如下方式执行:

.. automethod:: my.module.MyClass.funky

第三个选项:

.. currentmodule:: my.module

.. autoclass:: MyClass   

   .. automethod:: funky