如何分别向私人会员展示？

Question

目前，我将模块描述为：

.. autoclass:: package.module.class
   :members:
   :undoc-members:
   :show-inheritance:
   :private-members:
   :member-order: bysource

它显示了所有的成员在一排。我想要做的事情是：

.. autoclass:: package.module.class
   :members:
   :undoc-members:
   :show-inheritance:
   :member-order: bysource

Private methods
===============

.. autoclass:: package.module.class
   :noindex:
   :private-members:
   :member-order: bysource

因此，我不得不使用:noindex:：

警告:复制package.module的对象描述，类中的其他实例，使用:noindex:用于其中之一

但是，似乎:private-members:没有:members:就不会出现。这段代码只显示类对象docstring：

.. automodule:: package.module.class
   :noindex:
   :private-members:
   :member-order: bysource

这个东西将展示所有的类方法：

.. automodule:: package.module.class
   :noindex:
   :members:
   :private-members:
   :member-order: bysource

如何在不展示其他东西的情况下向私人会员展示？

Answer 1

这并不能直接回答您的问题，但我编写了一个名为[医]蒸压器的Sphinx插件，其确切目的是在类文档中直观地将公共方法和私有方法分开。插件的基本思想是创建一个指向类的所有属性的链接列表，这些链接被组织成一些节，如Public/Private、attribute /Method、继承的等等。每个属性的详细文档按字母顺序排列，但组织的列表使类的结构变得清晰。

下面是这个插件将使用的语法示例。只是在你已经拥有的基础上添加了一行：

.. autoclass:: package.module.class
     :members:
     :undoc-members:
     :show-inheritance:
     :private-members:
     :member-order: bysource

     .. autoclasstoc::