使用 GitLab + 阅读文档以获取有关私有 VM 的文档：RTD 构建失败
Using GitLab + Read the Docs for documentation on a Private VM: RTD build fails
背景
我是一名技术作家，试图使用“阅读文档”为我们的一个产品生成文档。由于我们对任何出版物都有保密协议，因此我必须将文档托管在虚拟机上，以供具有 Intranet 访问权限的客户阅读。
安装
Git实验室
我的虚拟机是 CentOS 8。我通过 Docker 安装了 GitLab Community Edition。我在 root 帐户下为我的 Markdown 源代码创建了一个存储库，存储库的地址是 http://${vm_address}/root/${repo_name}。 Git实验室容器在我的 VM 的端口 20 上运行。
阅读文档
由于 RTD 不正式支持内部部署，我从 Docker 中提取了一个非官方图像。参见 vassilvk/readthedocs。这个 RTD 容器在我的虚拟机的 8000 端口上运行。我使用用户名“admin”登录 RTD。
我为整合 GitLab 和 RTD
而采取的程序
要在我的 Git 实验室中导入源代码，我执行了以下操作：
- 在项目页面上，单击导入项目。
- 单击左侧面板上的手动导入。
- 在项目详细信息页面中，填写以下字段：
- 项目名称：${my_project_name}
- 存储库 URL：${Clone_With_HTTP_Address}
I copied the URL from the "Clone with HTTP" field under the Clone button dropdown in GitLab
- 存储库类型：Git
- 在高级项目选项中，我将文档类型设置为Sphinx HTML.
- 单击完成。
结果
构建失败，错误代码为 1。
问题
- RTD项目设置我哪里做错了？
- 我的 RTD 或 Git实验室容器设置有问题吗？
- 我还需要在 VM 上安装 Sphinx 吗？
由于我们对任何出版物都有保密协议，因此我必须托管文档
这根本不成立。您一定是看错了 ReadTheDocs。有两个站点：
- ReadTheDocs.org - 这是免费的、公开可见的主机。
- ReadTheDocs.com - 这就是您想要的，它为您的企业托管私人存储库。
除非您处于管理良好、安全的 IT 环境中，否则您自己 VM 上的 运行 随机 Docker 图像几乎肯定会导致无意泄露。您从事托管业务吗？不。当你只想写一些私人文档时，不要玩托管业务。有相应的产品。
背景
我是一名技术作家，试图使用“阅读文档”为我们的一个产品生成文档。由于我们对任何出版物都有保密协议，因此我必须将文档托管在虚拟机上，以供具有 Intranet 访问权限的客户阅读。
安装
Git实验室
我的虚拟机是 CentOS 8。我通过 Docker 安装了 GitLab Community Edition。我在 root 帐户下为我的 Markdown 源代码创建了一个存储库，存储库的地址是 http://${vm_address}/root/${repo_name}。 Git实验室容器在我的 VM 的端口 20 上运行。
阅读文档
由于 RTD 不正式支持内部部署，我从 Docker 中提取了一个非官方图像。参见 vassilvk/readthedocs。这个 RTD 容器在我的虚拟机的 8000 端口上运行。我使用用户名“admin”登录 RTD。
我为整合 GitLab 和 RTD
而采取的程序要在我的 Git 实验室中导入源代码，我执行了以下操作：
- 在项目页面上，单击导入项目。
- 单击左侧面板上的手动导入。
- 在项目详细信息页面中，填写以下字段：
- 项目名称：${my_project_name}
- 存储库 URL：${Clone_With_HTTP_Address}
I copied the URL from the "Clone with HTTP" field under the Clone button dropdown in GitLab - 存储库类型：Git
- 在高级项目选项中，我将文档类型设置为Sphinx HTML.
- 单击完成。
结果
构建失败，错误代码为 1。
问题
- RTD项目设置我哪里做错了？
- 我的 RTD 或 Git实验室容器设置有问题吗？
- 我还需要在 VM 上安装 Sphinx 吗？
由于我们对任何出版物都有保密协议，因此我必须托管文档
这根本不成立。您一定是看错了 ReadTheDocs。有两个站点：
- ReadTheDocs.org - 这是免费的、公开可见的主机。
- ReadTheDocs.com - 这就是您想要的，它为您的企业托管私人存储库。
除非您处于管理良好、安全的 IT 环境中，否则您自己 VM 上的 运行 随机 Docker 图像几乎肯定会导致无意泄露。您从事托管业务吗？不。当你只想写一些私人文档时，不要玩托管业务。有相应的产品。