在谷歌应用引擎项目上构建Sphinx Autodoc

Question

我有一个Google App Engine项目，我正试图用Sphinx文档。我试图使用autodoc功能为我的许多模块/类/函数。

My 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。有什么解决办法吗?

p。我没有嫁给斯芬克斯。我愿意接受眼科医生或其他选择。

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