如何在Sphinx中制作文档时提供系统路径?

时间:2014-04-11 11:24:58

标签: python documentation python-sphinx ubuntu-13.10

我正在使用Ubuntu 13.10版本并在 pyDev 中使用 eclipse IDE制作python项目。我想要记录它。为此,我点击链接Documenting python code using 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文件都是空的。没有显示任何文档。

1 个答案:

答案 0 :(得分:0)

尝试:

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

如果它不起作用,请提供项目的文件夹结构。

另见Python-Sphinx: How to document one file with functions?,示例命令可能会有所帮助。