python - Google App Engine プロジェクトで Sphinx Autodoc を構築する

Question

Sphinx で文書化しようとしている Google App Engine プロジェクトがあります。多くのモジュール/クラス/関数で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

このファイルはwebapp2urlsをインポートします。これは、今度は appengine.api をインポートしようとするでしょう。私のに提供することは不可能だと思います。回避策はありますか？appengine.apisys.path

PS。私はスフィンクスと結婚していません。私はepydocまたは代替案に対してオープンです。

Answer 1

を呼び出す前に、 AppEngine SDKをダウンロードして PYTHONPATH を設定できますmake html。

たとえば、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