Создание Sphinx Autodoc на основе проекта Google App Engine

У меня есть проект 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. Есть ли обходной путь?

PS. Я не замужем за Сфинксом. Я был бы открыт для эпидока или альтернатив.


python google-app-engine python-sphinx autodoc
person zzz    schedule 27.09.2011    source источник

Ответы (1)


arrow_upward
3
arrow_downward

Вы можете загрузить SDK AppEngine, а затем установить 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
person jterrace    schedule 27.09.2011