Sphinx исключает членов с помощью директивы include, используя - PullRequest
0 голосов
/ 24 декабря 2018

Это моя структура проекта:

 base/devices.py
 users/devices.py
 company/devices.py

Вот мой index.rst:

.. My documentation master file.

Welcome to documentation!
=========================

.. toctree::
    :maxdepth: 3
    :caption: Contents:

    users.rst
    company.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

base/devices.txt:

.. automodule:: base.devices
   :noindex:  # base docs may be included in several .rst files
   :members:

users.rstи company.rst похожи:

USERS
*****

Devices
=======

.. include:: base/devices.txt

.. automodule:: users.devices  # in company.rst "company.devices"
   :members:

В base/devices.py У меня есть функция check_devices()
В users/devices.py У меня есть функция check_devices(), но с другой строкой документов и другим поведением

И когда я генерирую документацию на своей странице пользователей, я вижу обе функции: base.devices.check_devices и users.devices.check_devices

Как я могу исключить base.devices.check_devices строку документации со страницы пользователей, не теряя возможности включить base/devices.txtв нескольких первых файлах и без стиля копирования-вставки?

...