python - 在 App Engine 上安装 Sphinx - 可能吗?

标签 python google-app-engine python-sphinx

跟进我的 last year's question关于文档,我现在想开始尝试基于 Python 的 Sphinx用于整理我一直在使用的 PHP CMS 的开发人员文档。

我不想在我的工作站上本地设置 Python,而是希望从一开始就在可公开访问的 Web 服务器上运行它。我有权访问的所有网络托管包都在 LAMP 堆栈上运行,我不愿意购买基于 Python 的托管。我对 Google App Engine 很感兴趣,他们提供的免费配额对我来说是一百倍,即使不是,他们的定价看起来也很合理。

现在我对 Python 的了解为零——让 Sphinx 工作将是我第一次接触它——而且时间很少。据我所知,App Engine 提供的平台和 Python 库与标准 Python 库非常兼容,但完全相同

所以我的问题是:

  • Sphinx 能否在 App Engine 上运行?

  • 在 App Engine 上安装 Sphinx 是否像在普通 Python 安装之上安装一样简单?或者 App Engine 的环境是否需要调整源代码,而我目前的 Python 水平无法在合理的时间内执行?

  • 我是否应该先在本地服务器上安装 Sphinx 和“普通”Python 堆栈?

  • 有人知道这方面的任何有用的操作方法、教程或其他资源吗?

最佳答案

您根本不需要在 GAE 上安装 Sphinx。

您使用 Sphinx 创建静态 HTML、CSS 和 JS 的目录。完成此步骤后,您只需上传 Sphinx 的完整输出。

Sphinx 的输出(HTML、CSS 和 JS)只是从一个地方提供。您将文档从创建它的地方上传到 GAE 作为静态文件并提供给它们。完成。

Sphinx 根本没有“安装在 Web 服务器上”这一方面。 Sphinx 不是 Web 应用程序;它不在您的网络服务器上运行。您在开发中短暂运行它以将文档发布为 HTML、LaTeX 或其他格式。一旦您创建了静态 HTML 文件,您就不再需要任何地方的 Sphinx 的任何部分。

Can Sphinx run on App Engine at all?

我想它可以,但你永远不需要。

Is installing Sphinx on the App Engine as straightforward as...

没关系,因为你不会把它安装在那里。您将它安装在您的工作站上并在您的工作站上使用它。

Should I be installing Sphinx on a local server and a "normal" Python stack instead first?

不要将其安装在服务器上。在您的工作站上安装它。

Does anybody know any helpful How-to's, tutorials or other resources for this?

如果“这个”是指“在网络服务器上安装”,那么答案是“否”。人们不会将其安装在 Web 服务器上。因此,没有关于“在 Web 服务器上安装”的操作方法、教程或资源。

如果“这个”是指“使用 Sphinx 创建文档”,那么答案是“https://www.sphinx-doc.org 有什么问题?它们缺少什么?


I would like Sphinx's "engine" that turns the input (consisting of reST files) into HTML/CSS/JS to be accessible from anywhere to make me (and possible other contributors) independent from a specific workstation.

Sphinx 就像一个编译器。每个人的工作站上都​​有自己的副本。他们下载文档源、进行更改、提交源更改并上传生成的文档。

serve the generated documentation from the same place.

正确。下载源代码、进行更改、重新生成文档并提交更改后,您上传生成的文档,以便从一个且仅一个位置提供服务。

Sphinx 是一个编译器。它不是“网络引擎”。这是一个简单的编译器,可以将您的文档编译成 HTML,以便提供。

关于python - 在 App Engine 上安装 Sphinx - 可能吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/2522255/

相关文章:

google-app-engine - 将 Google Datastore 备份从数据存储加载到 Google BigQuery

python - Tesseract OCR 未返回验证码图像的正确结果

python - 使用 Django Rest Framework 从列表中的对象序列化自定义字段

python - 如何在 PyGame 上正确重新缩放图像而不被严重裁剪?

python - 在 Google App Engine 上使用 Django 限制对 Shopify API 的 API 调用速率

java - 使用 Dataflow API 启动时将参数传递给模板

python - 在 Sphinx 文档中包含源代码

html - 如何将 rel 属性添加到 HTML 输出中的 docutils sphinx 引用?

python - 缺少 sphinx 命令的 conf 文件

python - 使用 argparse 指定文件扩展名