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

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

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

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

Любые идеи?

источник

2015-01-17 Márcio

Вы можете показать полную команду, которую используете для создания документа? –

Из https://readthedocs.org/projects/argf/builds/3296530/: 'python /home/docs/checkouts/readthedocs.org/user_builds/argf/envs/latest/bin/sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language = ru. _build/html' –

Я собирался зайти сюда и рассказать вам так же, как вы, в 'sphynx', с' #: 'непосредственно перед членом ... но похоже, что вы уже пробовали это, поэтому вместо этого +1 в надежде на то, что вы получите хороший ответ :) –

В случае, если вы используете расширение Наполеона обрабатывать 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

при реализации этого метода вы имеете мелкозернистый выбор которого член собирается быть включен в документах и который не является.

источник

2015-11-04 14:57:03 marscher

https://stackoverflow.com/questions/15903577/include-specific-special-methods-in-sphinx – marscher

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

ответ

Смежные вопросы