sphinx-apidoc создает документацию для класса, реэкспортированного в __init__.py - PullRequest
Новая
       35

sphinx-apidoc создает документацию для класса, реэкспортированного в __init__.py

0 голосов
/ 08 июня 2019

В mypkg/_core.py У меня 

class SomeClass:
    """Here is my class."""

    def __init__(self, x: int):
        self.x = x

В __init__.py У меня 

from mypkg._core import SomeClass

Я полагаю, что есть конфигурация по умолчанию, чтобы избежать документирования всего, что импортировано, и это нормально. В моем случае _core.py - это закрытый модуль, и я не хочу его документировать. Я хочу, чтобы эта документация экспортировалась в документацию модуля верхнего уровня mypkg.

Я хочу, чтобы SomeClass появился в документации mypkg верхнего уровня, но это не так.

...