在Google App Engine项目中构建Sphinx Autodoc

Question

我有一个Google App Engine的项目，想用Sphinx来做文档。我正在尝试使用autodoc这个功能来处理我的很多模块、类和函数。

这是我写的Sphinx reST标记：

.. automodule:: urls
   :members: Urls

当我运行make html时，出现了一个错误：

WARNING: autodoc can't import/find module 'urls', it reported error: "No module >named appengine.api", please check your spelling and sys.path

这个urls文件引入了webapp2，我觉得它会尝试去引入appengine.api。我想我无法把appengine.api添加到我的sys.path中。有没有什么解决办法？

顺便说一下，我并不一定要用Sphinx。如果有epydoc或者其他替代方案，我也很乐意尝试。

Answer 1

你可以去下载 AppEngine SDK，然后在运行 make html 之前设置你的 PYTHONPATH。

比如，我下载了这个 SDK，然后可以这样做：

$ ls /home/jterrace/Downloads/google_appengine/google/
appengine  __init__.py  net  pyglib  storage
$ PYTHONPATH="/home/jterrace/Downloads/google_appengine/google" python
Python 2.7.1+ (r271:86832, Apr 11 2011, 18:13:53) 
[GCC 4.5.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import appengine
>>> import appengine.api
>>> 

所以，你可以这样做：

PYTHONPATH="/home/jterrace/Downloads/google_appengine/google" make html