Как мне документировать классы без имени модуля?
Я пытаюсь документировать пакет Python сsphinx
и успешно сгенерировал HTML-файлы. Пакет, который я документирую, состоит из набора*.py
файлы, большинство из которых содержат один класс с парой файлов, являющихся подлинными модулями с определенными функциями. Мне не нужно раскрывать тот факт, что каждый класс находится в модуле, поэтому я добавил подходящийfrom
заявления в__init__.py
файл, например
from base import Base
так что пользователь может использоватьimport pkg
команда и тогда не нужно указывать модуль, который содержит класс:
import pkg
class MyBase(pkg.Base): # instead of pkg.base.Base ...
...
Проблема в том, что сфинкс настаивает на документировании класса какpkg.base.Base
, Я пытался установитьadd_module_names = False
вconf.py
, Однако это приводит к тому, что сфинкс показывает класс простоBase
вместоpkg.Base
, Кроме того, это также разрушает документацию пары*.py
файлы, которыенаходятся модули.
Как мне сделатьsphinx
показать класс какpkg.Base
? И как мне установитьadd_module_names
директива выборочно для каждого*.py
файл?