Есть ли способ переопределить текст, отображаемый директивой автокласса reST?

Я создал документацию, используя директиву autoclass в reST, и она генерирует заголовок для класса следующим образом:

Прочитать пример документации

Однако я хочу, чтобы он не говорил dataframe.DataFrame, а вместо этого EzPyZ.DataFrame (или действительно любое ручное переопределение этого текста по умолчанию). Это код, который я использовал:

.. autoclass:: dataframe.DataFrame

python-sphinx autodoc read-the-docs restructuredtext
person Ethan Guthrie    schedule 29.11.2020    source источник
comment
Я в замешательстве. Если вы хотите, чтобы на выходе было написано EzPyZ.DataFrame, почему бы вам не использовать .. autoclass:: EzPyZ.DataFrame?   -  person mzjn    schedule 29.11.2020
comment
@mzjn спасибо. Я просто придурок.   -  person Ethan Guthrie    schedule 29.11.2020
comment
@EthanGuthrie добро пожаловать в MoronOverflow, где всегда рады новичкам. ????   -  person Steve Piercy    schedule 30.11.2020

Ответы (1)


arrow_upward
0
arrow_downward

Ответ такой, как я и ожидал. Я придурок. Как отметил @mzjn, все, что мне нужно было сделать, это просто сказать:

.. autoclass: EzPyZ.DataFrame

Autodocs заполнит указанный вами путь, если это допустимый путь к классу. В моем случае (см. структуру каталогов ниже) доступ к классу Column можно получить, используя либо EzPyZ.column.Column, column.Column (поскольку autodoc неявно импортирует целевой пакет для документации), либо (как я хотел) EzPyZ.Column.

  EzPyZ
    └── EzPyZ
          ├── __init__.py
          ├── column.py      # Contains Column class.
          ├── dataframe.py   # Contains DataFrame class.
          └── tools
                ├── __init__.py
                └── read_files.py    # Contains some extra functions.
person Ethan Guthrie    schedule 29.11.2020