python - Sphinxから生成されたHTMLドキュメントをGitHubにアップロードするにはどうすればよいですか？

Question

コードのロードをドキュメント化し、sphinxを使用してドキュメントを生成する方法を学びました。それをGitHubプロジェクトページに含めたいのですが、その方法がわかりません。誰かが既存のチュートリアルまたはそうするための簡単なステップを知っていますか？

Answer 1

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

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

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

Answer 2

John Paulettの答えは明らかに正しく、ほとんどのユーザーにとってすでに十分である可能性があります（+1）。

または、GitHubに関するBen Welshの完全なチュートリアルSphinxドキュメントを確認することもできます。このドキュメントでは、ステップバイステップの手順と、それらを結び付ける便利なファブリックベースのスクリプト/タスクを提供して、コードと一緒にドキュメントをすばやく公開し始めます[... ]単一のコマンドを介して。

Answer 3

github-toolsには、あなたが求めていることを正確に実行する機能があります。

paver gh_pages_create gh_pages_build

プロジェクト用に設定する方法については、優れたドキュメント（もちろんそれ自体を使用）を参照してください。