Python 製ドキュメンテーションツールの Sphinx を使ってドキュメントを作成し、GitHub Pagesに公開するまでの手続きです。 なお、Sphinx-Users.jpによる手順も公開されていますので、そちらを参照してもよいでしょう。 Mac OS X 上の pyenv 環境で実施しましたが、多くの手順は環境によらないでしょう。 事前準備 GitHub 上でドキュメント用のリポジトリを作成しておきます。 以降ではこのリポジトリを仮に bob/foo-doc として扱います。 Sphinx Install チュートリアルに従って、Sphinx のインストールから実施していきます。
![Sphinx でドキュメントを作成して GitHub Pages で公開するまで - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/5fa208984211e26fe808bc432ac3107fa27fc660/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-9f5428127621718a910c8b63951390ad.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9U3BoaW54JTIwJUUzJTgxJUE3JUUzJTgzJTg5JUUzJTgyJUFEJUUzJTgzJUE1JUUzJTgzJUExJUUzJTgzJUIzJUUzJTgzJTg4JUUzJTgyJTkyJUU0JUJEJTlDJUU2JTg4JTkwJUUzJTgxJTk3JUUzJTgxJUE2JTIwR2l0SHViJTIwUGFnZXMlMjAlRTMlODElQTclRTUlODUlQUMlRTklOTYlOEIlRTMlODElOTklRTMlODIlOEIlRTMlODElQkUlRTMlODElQTcmdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT01NiZ0eHQtY2xpcD1lbGxpcHNpcyZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPTBlMzIxNjFlNWMyOGMwOWVhN2JkYzNlNTc1ZDY1YTU5%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQwa2V5LWFtYiZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTM2JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9NDgwNTVjZDBhZjY5ZDVlOGZhN2FjNTE0YzAxZDlhZTY%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3D94d5a88dbe3c278fa6fc0da73fec5839)