sphinxからgithubに生成されたhtmlドキュメントをアップロードするには？

Question

私は自分のコードの負荷を文書化し、ドキュメントを生成するためにsphinxを使用する方法を学びました。私はそれを私のgithubプロジェクトページに含めるが、私はどのようにするのか分からない。誰でも既存のチュートリアルや簡単なステップを知っていますか？

ありがとうございました。

Answer 1

githubは、github pages機能を使用して静的コンテンツを配信します。基本的には、静的ページをコミットするgh-pagesというブランチを作成します。ページはyou.github.com/yourprojectで提供されます。

http://pages.github.com/の手順を参照してください。

スフィンクスでは、アンダースコアの先頭にディレクトリがあるため、githubのSphinxを使用して問題が発生する可能性があります。これを修正するには、生成されたsphinx htmlを含むディレクトリに.nojekyllというファイルを追加します。

paver gh_pages_create gh_pages_build 

は、あなたのプロジェクトのためにそれを設定する方法についてexcellent documentation（もちろん自分自身を使用して）を参照してください：

Answer 2

github-toolsは、あなたが求めているかを正確にやっ機能を備えています。

Answer 3

John Paulett's answerは明らかに正しく、既にほとんどのユーザーにとっては（+1）十分です。

また、あなたはあなたのコードの[一緒にドキュメントを公開迅速に始めるために一緒にステップバイステップのインストラクションだけでなく、便利Fabricベースのスクリプト/タスクそれらを結ぶを提供ベン・ウェールズの徹底したチュートリアルSphinx documentation on GitHubを、チェックアウトする場合があります。 ..]を1つのコマンドで実行します。