Сделать чтение документов включает в себя документацию по автодоку для специальных участников?

У меня есть модуль с двумя документальными глобальными специальными членами.

Запуск Sphinx локально создает документацию, которая включает их документы, но в Read Docs нет. Вместо этого используется документация с встроенным типом.

Я попытался использовать оба стиля: #: и docstring после определения. Я несколько раз читал документацию по autodoc, а прочитал запись Docs на нем. Я не могу понять, что мне не хватает, поскольку я даже не вижу ошибок сборки при чтении документов.

Ответы

Ответ 1

Если вы используете расширение Napoleon для обработки docstrings в стиле NumPy или Google, вы можете установить для него этот флаг конфигурации в conf.py

http://sphinx-doc.org/ext/napoleon.html?highlight=special#confval-napoleon_include_special_with_doc

Если я правильно помню, есть также директива для autodoc:

http://sphinx-doc.org/ext/autodoc.html?highlight=member#event-autodoc-skip-member

Внедряя этот метод, у вас есть мелкий выбор, какой член будет включен в документы, а какой нет.