Создание Sphinx Autodoc на проекте Google App Engine - PullRequest
Новая
       6

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

1 голос
/ 27 сентября 2011

У меня есть проект 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 import webapp2 , который, я считаю, в свою очередь попытается импортировать appengine.api.Я не думаю, что возможно предоставить appengine.api моему sys.path.Есть ли обходной путь?

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

1 Ответ

3 голосов
/ 27 сентября 2011

Вы можете скачать 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
...