python - 如何为 Google App Engine 项目构建 sphinx(阅读文档)文档？

Question

我有一个名为 gaend 的 Google App Engine 项目。我正在尝试使用 readthedocs 为其构建更好的文档。我用过

> sphinx-quickstart

构建我的基础 sphinx 项目。随后

> sphinx-apidoc -o . ../gaend

生成项目的API列表。然后我运行

sphinx-autobuild . _build/html

+--------- manually triggered build ---------------------------------------------
| Running Sphinx v1.5.2
| loading pickled environment... done
| building [mo]: targets for 0 po files that are out of date
| building [html]: targets for 0 source files that are out of date
| updating environment: 0 added, 1 changed, 0 removed
| reading sources... [100%] gaend
/Users/stephen/gaend/docs/gaend.rst:10: WARNING: autodoc: failed to import module u'gaend.bigquery'; the following exception was raised:
Traceback (most recent call last):
File "/Users/stephen/.virtualenvs/gaend/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 551, in import_object
__import__(self.modname)
File "/Users/stephen/gaend/gaend/bigquery.py", line 1, in <module>
   from google.cloud import bigquery
ImportError: No module named google.cloud
...
ImportError: No module named google.appengine.ext

我发现问题在于它无法访问 Google Cloud SDK。我在运行单元测试时遇到了类似的问题，解决方法是 runner.py 。但是，这依赖于我的系统上的某个位置是否有 Google Cloud SDK(安装了 Python Google App Engine 模块)。我如何在 readthedocs 上获取 Google Cloud SDK(和 Python GAE)构建我的文档的服务器？

Answer 1

我遇到了同样的问题，我不记得在哪里找到了解决方案，也许无法解决您的问题，但我通过添加 google_appengine 文件夹和 google_appengine/的路径解决了我的问题Sphinx doc 文件夹内源文件夹中 conf.py 文件中的 lib/yam/lib 文件夹，如下所示:

在conf.py中:

sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(1, '<your local full path>/google_appengine')
sys.path.insert(1, '<your local full path>/google_appengine/lib/yaml/lib')

if 'google' in sys.modules:
    del sys.modules['google']

我知道相对路径会更好，但它对我有用。

Sphinx 需要运行您正在记录的程序，我不太明白，但无论如何，它是一个很好的工具。