使用私有git存储库阅读文档

Question

我安装了read-the-docs，从私有git存储库上的项目开始生成文档，需要用户/密码验证。

手动导入项目时，如何设置用户和密码以允许读取文档来克隆存储库？

非常感谢， 最大

Answer 1

我最近遇到了同样的问题。这里还有另一个问题 Why can't I clone a git repo for readthedocs to build the documentation?中，作者对此问题给出了自己的结论。

此处写着https://docs.readthedocs.io/en/latest/open-source-philosophy.html，readthedocs为开源项目提供了官方支持。据我了解，私有回购的使用假定该软件不是开源的。这里https://docs.readthedocs.io/en/latest/business/index.html是专门关于私人回购协议的：解决方案是使用付费服务readthedocs.com

几天后，我收到了来自支持部门的以下电子邮件（我特别询问了VS Online）：

我们在社区站点readthedocs.org上不支持私有存储库-仅适用于开源软件。我们不直接通过商业托管来支持VSTS或VS Online，但是至少支持存储库的SSH克隆。如果您的软件不是开源的，我建议在那儿试用一个帐户。

Answer 2

如果我理解正确，那么您正在运行readthedocs.org的本地克隆。 要允许SSH克隆私人仓库，您可以创建文件/readthedocs/settings/local_settings.py（如果尚未完成）并添加以下设置：

ALLOW_PRIVATE_REPOS = True

只需确保用户rtd的运行方式为SSH pubkey即可访问存储库。