Sphinx
Sphinx是一个可以轻松创建文档的工具,最初是为发布 Python 文档而设计的。它以简单易用而著称。
在本指南中,你将创建一个新的 Sphinx 项目并使用 Cloudflare Pages 进行部署。
先决条件
Python 3.7 的最新版本是 3.7.11:
安装 Python
有关安装指导,请参阅 Python 官方文档:
安装 Pipenv
如果你在安装 3.7 版之前已经安装了较早版本的 Python,那么你可能已经安装的其他全局包可能会干扰下面安装 Pipenv 的步骤,或你的其他依赖于全局包的 Python 项目。
Pipenv是一个基于 Python 的软件包管理器,可让虚拟环境管理变得简单。本指南不要求你事先具备使用 Pipenv 的经验或知识以完成 Sphinx 站点部署。Cloudflare Pages 本身支持使用 Pipenv,默认情况下已安装最新版本。
安装 Pipenv 的最快方法是运行命令:
该命令将把 Pipenv 安装到用户层目录,并可通过终端访问。运行以下命令并查看预期输出即可确认:
创建 Sphinx 项目目录
在终端运行以下命令创建新目录并导航到该目录:
使用 Python 3.7 的 Pipenv
Pipenv 允许你指定与虚拟环境相关联的 Python 版本。在本指南中,Sphinx 项目的虚拟环境必须使用 Python 3.7。
使用以下命令
输出结果如下
列出目录内容:
安装Sphinx
安装 Sphinx 之前,请创建你希望项目所在的目录。
在终端运行以下命令安装 Sphinx:
你应该会看到类似下面的输出:
这将把 Sphinx 安装到由 Pipenv 管理的新虚拟环境中。你应该看到这样的目录结构:
创建一个新项目
安装好 Sphinx 后,现在就可以运行 quickstart 命令,为自己创建一个模板项目。该命令只能在上一步创建的 Pipenv 环境中运行。要进入该环境,请在终端运行以下命令:
现在运行以下命令
你将收到一些问题,请在下面回答:
这将在你的活动目录中创建四个新文件:source/conf.py
、index.rst
、Makefile
和make.bat
:
现在,你已经拥有了开始将网站部署到 Cloudflare 页面所需的一切。如需了解如何使用 Sphinx 创建文档,请参阅官方 Sphinx 文档。
在你继续之前
所有框架指南都假定你已经对 Git 有了基本了解。如果你是 Git 的新手,请参考这本 Git 手册摘要,了解如何在本地机器上设置 Git。
如果使用 SSH 克隆,则必须在每台用于从 GitHub 推送或拉取的计算机上 生成 SSH 密钥。
创建 GitHub 仓库
<! – 待办事项:检查,我们是否需要在这里指定所有各种 ssh + 配置? (如果没有,则应使用 _create-github-repository 部分)–>
在 pipenv shell 会话之外的另一个终端窗口中,验证基于 SSH 密钥的身份验证是否正常:
访问 repo.new,创建一个新的 GitHub 仓库。仓库建立后,在终端运行以下命令,将应用程序推送到 GitHub:
使用 Cloudflare 页面部署
将网站部署到页面:
- 登录 Cloudflare 仪表板 并选择你的账户。
- 在账户主页,选择 工作者和页面> 创建应用程序> 页面> 连接到 Git。
- 选择创建的新 GitHub 仓库,并在
**设置构建和部署**
部分提供以下信息:
Configuration option | Value |
---|---|
Production branch | main |
Build command | make html |
Build directory | build/html |
在配置下方,请确保设置用于指定 PYTHON_VERSION
的环境变量。
例如
Variable name | Value |
---|---|
PYTHON_VERSION | 3.7 |
配置网站后,你可以开始首次部署。在部署之前,你应该看到 Cloudflare 页面正在安装 Pipenv
、项目依赖项并构建网站。
部署网站后,你将在 *.pages.dev
上为你的项目获得一个唯一的子域。每次你向 Sphinx 网站提交新代码时,Cloudflare Pages 都会自动重建你的项目并进行部署。
你还可以访问新的拉取请求上的 预览部署,这样你就可以在将更改部署到生产环境之前预览网站的外观。
了解更多
完成本指南后,你已成功将 Sphinx 网站部署到 Cloudflare Pages。要开始使用其他框架,请参阅框架指南列表