Автодок Сфинкса ничего не импортирует?

Question

Я пытаюсь использовать 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.

Итак, что я делаю не так?

Answer 1

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

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

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

Answer 2

Как говорится, вам следует сделать:

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

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