python-sphinx
Написание докстерий с использованием autodoc

C++ CSS Django Flask Git HTML JavaScript latex MATLAB Language Python Language

Вступление

Sphinx позволяет включать в документацию докстры, используя расширение autodoc, которое поставляется вместе с пакетом. В этой документации будет показано, как отформатировать ваши документы и как их включить в вашу документацию.

Установка расширения автодока

Добавьте модуль autodoc в list extensions присутствующих в файле conf.py в корне вашей документации:

extensions = [
    'sphinx.ext.autodoc',
     ...
]

Добавление кода в конфигурацию sphinx

Autodoc должен импортировать ваши модули для работы.

Вы можете включить свой код в свой файл conf.py

Например:

import os
sys.path.insert(0, os.path.abspath('../src'))

Modified text is an extract of the original Stack Overflow Documentation

Лицензировано согласно CC BY-SA 3.0

Не связан с Stack Overflow