部署发布

切换语言: Deployment

文档构建方式

当前仓库使用 doc/source 下的 Sphinx 源文件。预期发布流程是：

1. 在仓库中维护中英文 .rst 文档；

2. 通过 Sphinx 构建静态 HTML；

3. 将构建结果发布到 GitHub Pages。

为什么选择 GitHub Pages

GitHub Pages 很适合这个项目，因为：

• 文档与代码可以放在同一个仓库里；

• 不需要额外新建文档仓库；

• 站点 URL 规则稳定，便于展示；

• 文档和代码版本更容易保持一致。

预期站点地址

对于普通项目仓库，公开地址通常会是：

https://<github-username>.github.io/Enhancer-Promoter-Interaction/

构建方式选择

常见有两种：

• 本地构建后发布生成好的 HTML；

• 用 GitHub Actions 自动构建并部署。

从长期维护角度看，第二种更干净，因为仓库主要保存文档源码，而不是反复提交 生成产物。

建议的发布路径

对这个仓库，更实用的方式是：

• Sphinx 源码放在 doc/；

• 用 GitHub Actions 自动构建；

• 将构建结果部署到 GitHub Pages；

• 部署成功后，把最终站点地址写入 README.md。

需要的账号与权限

如果通过 GitHub Pages 发布，通常需要：

• GitHub 账号；

• 对目标仓库的访问权限；

• 开启 Pages 和配置 Actions 部署的权限。

不需要的东西

• 不需要单独再建一个仓库；

• 不需要额外购买基础文档托管服务；

• 不需要一定使用 Read the Docs 这类平台。

下一步

等文档内容稳定后，下一步就是补上自动构建和发布流程，并把最终 URL 写入 README。