Пропускать приватные методы в документах, созданных Sphinx - PullRequest
Новая
       11

Пропускать приватные методы в документах, созданных Sphinx

0 голосов
/ 13 ноября 2018

Я использую sphinx для генерации документации для нашего Python API.Многие функции в Python API на самом деле являются функциями CIG / C ++ / Fortran в SWIG.Мне бы хотелось, чтобы обернутые функции появлялись в моих документах API, но у них нет строк документации, поэтому они не отображаются по умолчанию.Я не заинтересован в том, чтобы частные документы / методы / атрибуты появлялись в документах, но они появляются, когда я предоставляю директиву: undoc-members:.

Как показать только публичные имена, включая имена элементовбез строки документации?

Моя лучшая попытка конфигурации для модуля: 

.. automodule:: company.category.tool
    :autodoc_member_order: bysource
    :members:
    :undoc-members:
    :no-show-inheritance:
    :no-private-members:
    :no-ignore-module-all:
    :exclude-members: this,thisown,acquire,disown,own

(:no-ignore-module-all: требуется, поскольку упакованные имена импортируются из скомпилированной библиотеки и перечислены в __all__. Они игнорируются в противном случае) :no-private-members:, кажется, игнорируется, к сожалению.

...