Я пытаюсь использовать 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.
Итак, что я делаю неправильно?