在分支内生成 github 文档（不是 gh-pages）
Generate github docs within the branch (not gh-pages)
我正在尝试使用 sphinx 为我的包生成文档。自然地，我从更简单的案例开始，然后遵循 default tutorial, which worked fine. However, every other tutorial that I found 这条路径：重新关闭，创建一个 gh-pages 分支，删除其余部分并推送。
虽然我真的不明白后勤是如何运作的。理想情况下，我希望每个分支都有一个 docs，就像 this example, which produces this page 一样。但是我没有找到教如何做到这一点的教程。
这样（每个分支都有一个文档）我可以在分支的文档中记录我对每个分支的更改，然后它们将它们（文档和代码）自然地合并到 master 中。这也将使 versions/releases 的处理更加容易。
通过拥有一个包含文档的单独分支，我真的无法想象如何处理更改，特别是发布，因为理想情况下，每个版本都有一个版本的文档。 （当我向母版添加标签时，我是否必须手动切换到 gh-pages，记录更改并在那里创建一个类似的标签？我在这里真的迷路了。）
总结一下：
如何为每个分支设置一个 docs（如 my example）。
如何在文档中管理分支和发布？
干杯
您可以简单地添加一个包含您的文档的 README 文件，并将其提交到您拥有的每个分支。
由于每个分支都有不同的文件，因此您可以根据不同的内容管理每个分支。
如果您使用 git 集线器，您也可以使用模板来执行此操作。
我最终做到的方式是在我的主目录中创建一个工作树。因为我计划使用 sphinx，所以我在 this tutorial 之后的 repo/docs/_build/html 中创建了一个工作目录。
基本上，在你创建一个孤儿之后gh-pages命令是
git worktree add docs/_build/html gh-pages
假设您在 .git/..。这样你就可以在文档中设置 sphinx，它会将 html 构建到 html 目录中，即 gh-pages 分支。
我正在尝试使用 sphinx 为我的包生成文档。自然地，我从更简单的案例开始，然后遵循 default tutorial, which worked fine. However, every other tutorial that I found 这条路径：重新关闭，创建一个 gh-pages 分支，删除其余部分并推送。
虽然我真的不明白后勤是如何运作的。理想情况下，我希望每个分支都有一个 docs，就像 this example, which produces this page 一样。但是我没有找到教如何做到这一点的教程。
这样（每个分支都有一个文档）我可以在分支的文档中记录我对每个分支的更改，然后它们将它们（文档和代码）自然地合并到 master 中。这也将使 versions/releases 的处理更加容易。
通过拥有一个包含文档的单独分支，我真的无法想象如何处理更改，特别是发布，因为理想情况下，每个版本都有一个版本的文档。 （当我向母版添加标签时，我是否必须手动切换到 gh-pages，记录更改并在那里创建一个类似的标签？我在这里真的迷路了。）
总结一下：
如何为每个分支设置一个 docs（如 my example）。
如何在文档中管理分支和发布？
干杯
您可以简单地添加一个包含您的文档的 README 文件，并将其提交到您拥有的每个分支。
由于每个分支都有不同的文件，因此您可以根据不同的内容管理每个分支。
如果您使用 git 集线器，您也可以使用模板来执行此操作。
我最终做到的方式是在我的主目录中创建一个工作树。因为我计划使用 sphinx，所以我在 this tutorial 之后的 repo/docs/_build/html 中创建了一个工作目录。
基本上，在你创建一个孤儿之后gh-pages命令是
git worktree add docs/_build/html gh-pages
假设您在 .git/..。这样你就可以在文档中设置 sphinx，它会将 html 构建到 html 目录中，即 gh-pages 分支。