Блог

Главная - Вопросы по программированию - Есть ли способ переопределить текст, отображаемый директивой автокласса reST?

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

#python-sphinx #restructuredtext #read-the-docs #autodoc

#python-sphinx #restructuredtext #read-the-docs #autodoc

Вопрос:

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

Прочитайте пример документов

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

 .. autoclass:: dataframe.DataFrame

Комментарии:

1. Я в замешательстве. Если вы хотите, чтобы на выходе было указано EzPyZ.DataFrame , почему бы вам не использовать .. autoclass:: EzPyZ.DataFrame ?

2. @mzjn спасибо. Я просто идиот.

3. @EthanGuthrie добро пожаловать в MoronOverflow, где новичкам всегда рады. 😉

Ответ №1:

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

 .. autoclass: EzPyZ.DataFrame

Автодокументы заполнят путь, который вы укажете, если это допустимый путь к классу. В моем случае (см. Структуру каталогов ниже) Column доступ к классу можно получить с помощью либо EzPyZ.column.Column column.Column (поскольку autodoc неявно импортирует пакет targe для документации), либо (как я и хотел) 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.
Метки: ,