Question

我正在尝试使用sphinx为我的包生成文档。当然，我从更简单的情况开始，然后遵循default tutorial，这很好。但是，每个other tutorial that I found都遵循以下路径：重新关闭，创建gh-pages分支，删除其余部分并推送。

但是，我真的不明白物流如何以这种方式运作。理想情况下，我希望每个分支都有一个docs，就像产生this example的this page一样。但是我找不到教授如何做到这一点的教程。

这种方式（每个分支都有一个文档）我可以记录我对分支文档中每个分支的更改，然后将它们（文档和代码）自然地合并到主文件中。这也使得版本/发布的处理变得更加容易。

通过拥有一个具有文档的独立分支，我实际上无法直观地了解如何处理更改，特别是发布，因为理想情况下，每个版本都有一个版本的文档。（当我向主人添加标签时，我必须手动切换到gh-pages，记录更改并在那里创建类似的标签吗？我真的迷失在这里。）

总结一下：

如何为每个分支设置一个docs（例如my example）。

我如何管理文档中的分支和发布？

干杯

Answer 1

我最终做到这一点的方法是在我的主目录中创建一个工作树。自从我计划使用sphinx以来，我在this tutorial之后repo/docs/_build/html创建了一个workdir。

基本上，在创建孤立gh-pages之后，命令是

git worktree add docs/_build/html gh-pages

假设您在.git/..。这样你就可以在docs中设置sphinx，它会将html构建到html目录中，这就是gh-pages分支。

Answer 2

您只需添加包含文档的README文件，并将其提交给您拥有的每个分支。

由于每个分支将是一个不同的文件，因此您需要使用不同的内容来管理每个分支。

如果您使用git hub，您也可以使用模板来执行此操作。