ブランチ内でgithubドキュメントを生成する（ghページではない）

Question

私のパッケージにドキュメントを生成するためにsphinxを使用しようとしています。当然、私はより単純なケースから始め、default tutorialに続き、うまくいきました。ただし、other tutorial that I foundはすべてこのパスに従います。新しいパスを作成し、gh-pagesブランチを作成し、残りを削除して押します。

私は本当にこの方法で物流がどのように機能するのか理解できません。理想的には、this exampleのようにすべてのブランチに1つずつdocsを割り当てて、this pageを生成します。しかし、それを行う方法を教えるチュートリアルは見つかりませんでした。

このように（ブランチごとに1つのドキュメントを持つ）、ブランチのドキュメント内の各ブランチに変更を文書化し、それらを（ドキュメントとコードを）自然にマスターにマージすることができます。これにより、バージョン/リリースの処理もずっと簡単になります。

ドキュメントがある別のブランチを持つことで、変更を作業する方法や特別なリリースを視覚化することはできません。理想的には、リリースごとに1つのバージョンのドキュメントが必要です。 （私はマスターにラベルを追加すると、私は、手動でgh-pagesに切り替えて変更内容を文書化し、そこに似たラベルを作成できますか私は本当にここに迷ってしまいました？。）

まとめると：どうすればよい

私はmy exampleのように、各ブランチに対して1つのdocsを持っています。

そして、ドキュメントで支店やリリースを管理するにはどうすればよいですか？

乾杯

Answer 1

私が最終的にしたのは、私のメインディレクトリ内にワークツリーを作成していたことです。私はスフィンクスの使用を計画していたので、this tutorialに続いてrepo/docs/_build/htmlに作業ディレクトリを作成しました。あなたは孤児gh-pagesを作成した後

基本的には、コマンドは、.git/..であると仮定し

git worktree add docs/_build/html gh-pages 

です。こうすることで、docsでsphinxを設定でき、すでにhtmlディレクトリにあるgh-pagesブランチのhtmlディレクトリにビルドされます。

Answer 2

あなたは、単にREADMEファイルには、あなたのドキュメントが含まれています追加し、あなたが持っているすべての枝にそれをコミットすることができます。

ブランチごとに異なるファイルになるため、ブランチごとに違う内容のファイルを管理できます。

git hubを使用している場合は、テンプレートを使用してそのようにすることもできます。