Как указать системный путь при создании документации в Sphinx?

Я использую версию Ubuntu 13.10 и делаю проект python в pyDev с помощью Eclipse IDE. Я хочу сделать документацию по этому поводу. Для этого я перехожу по ссылке Документирование кода Python с помощью Sphinx .

Следующая процедура:

$ sphinx-apidoc -A "Zeb Mustafa" -F -o docs MyPackage/src/

После этого какой путь я должен вставить сюда:

sys.path.insert(0,os.path.abspath('/home/zeb/MyPackage/src/'))

Я также пробую это:

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

Над обеими строками дайте ошибку:

bash: syntax error near unexpected token `0,'

Как указать путь, чтобы conf.py знал, какой код использовать для создания документации?

После долгих копаний этой проблемы. В конечном итоге мне нравится:

$ make html

И

zeb@zeb-Lenovo-B570:~$ cd docs/
zeb@zeb-Lenovo-B570:~/docs$ make html
zeb@zeb-Lenovo-B570:~/docs$ sphinx-build -b html -d _build/doctrees  . _build//html

Все файлы .html пусты. Документация не показана.


python python-sphinx ubuntu-13.10
person Zeb    schedule 11.04.2014    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Пытаться:

sys.path.insert(0, os.path.abspath('..'))

Если это не работает, укажите структуру папок вашего проекта.

См. также Python-Sphinx: как задокументировать один файл с функциями? примеры команд могут оказаться полезными.

person jcarballo    schedule 11.04.2014
comment
Спасибо за ответ. Когда я редактирую conf.py, чтобы указать sys.path: #sys.path.insert(0, os.path.abspath('.')), та же проблема, когда я пишу это с помощью терминала, ошибка: bash: syntax error near unexpected token 0, '. I also uncomment the path in conf.py`, но снова ничего не меняется - person Zeb; 11.04.2014