python - 在 Google App Engine 项目上构建 Sphinx Autodoc

Question

我有一个 Google App Engine 项目，正在尝试使用 Sphinx 对其进行记录。我正在尝试使用 autodoc我的许多模块/类/函数的功能。

我的 Sphinx 休息标记:

.. 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。我认为不可能向我的 sys.path 提供 appengine.api。有什么解决办法吗？

PS。我没有和斯芬克斯结婚。我愿意接受 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