使用私有的git存储库读取文档

Question

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

当手动导入项目时，如何设置用户名和密码以允许read- the -docs克隆存储库？

非常感谢，麦克斯

Answer 1

我最近也遇到了同样的问题。这里还有一个类似的问题，作者给了his own conclusion关于这个问题的答案。

正如Read文档本身的人员所记录的那样，here - Read the Docs Open Source Philosophy只通过readthedocs.org为开源项目提供免费的官方支持。虽然这里提供了更多的文档- Read the Docs for Business建议仅将readthedocs.com用于商业目的。据我所知，私有repo的使用假设软件不是开源的。

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

在我们的社区网站readthedocs.org上，我们不支持私有存储库--它只支持开源软件。我们不支持VSTS或VS在线直接与我们的商业托管，但至少有支持SSH的存储库克隆。如果你的软件不是开源的，我建议在那里试用一个帐户。

Answer 2

如果我理解正确的话，您正在运行readthedocs.org的本地克隆。要允许私有存储库的SSH克隆，您可以创建文件/readthedocs/settings/local_settings.py (如果尚未创建)并添加以下设置：

ALLOW_PRIVATE_REPOS = True

只需确保用户rtd以具有访问存储库的SSH pubkey访问权限的身份运行。