在Sphinx中制作文档时如何设置系统路径？

Question

我正在使用Ubuntu 13.10版本，在pyDev中用Eclipse IDE做一个Python项目。我想为这个项目制作文档。为此，我参考了这个链接：使用Sphinx为Python代码编写文档。

以下是我遵循的步骤：

$ 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文件都是空的，没显示任何文档。

Answer 1

试试这个：

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

如果不行，请提供你项目的文件夹结构。

另外，可以看看这个链接：Python-Sphinx: 如何为一个包含函数的文件写文档？，里面的示例命令可能会对你有帮助。