Sphinx autodoc ничего не импортирует?

Я пытаюсь использовать sphinx (вместе с autodoc и numpydoc) для документирования моего модуля, но после базовой настройки запуск make html создает только базовый html без включенных строк документации. Я использую Python 3.3, схема структуры проекта выглядит следующим образом:

Kineticlib
|--docs
|  |--build
|  |--source
|  |  |--conf.py
|--src
|  |--kineticmulti
|  |  |--__init__.py
|  |  |--file1.py
|  |  |--file2.py
|--setup.py

__init__.py пусто, а в conf.py в каталоге docs/source я добавил sys.path.insert(0, os.path.abspath('../..'))

Запуск make html в каталоге docs дает следующий результат:

sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.2.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
no targets are out of date.

Build finished. The HTML pages are in build/html.

Итак, что я делаю неправильно?


person George Oblapenko    schedule 23.07.2014    source источник


Ответы (2)


Вы запускали sphinx-apidoc в каталоге docs/source? Это создаст файлы .rst, используемые для создания html. От 1_,

sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]

Вам нужно будет включить (как минимум) outputdir (где будут файлы .rst, ./ должно работать) и sourcedir, которые должны указывать на ваш пакет (похоже, ../../src/kineticmulti должен работать )

person Gabriel    schedule 23.07.2014
comment
Да, я забыл это сделать. - person George Oblapenko; 23.07.2014

Как говорится, вы должны сделать:

sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]

Иногда также необходимо изменить ваш conf.py для импорта некоторых исходных модулей. А также добавить некоторые документы в класс, чтобы загрузить документы его методов (может быть верно только для частных классов, но я застрял на этом).

person LinearLeopard    schedule 12.11.2019