読者です 読者をやめる 読者になる 読者になる

Yasuo's Notebook

ソフトウェア開発の話題が中心の備忘録です。

Sphinx+GitHub+BuildHiveで作る手軽なソーシャルドキュメンテーション環境


テキストで書かれたドキュメントのソースをGitHubで共有してJenkinsでHTMLやPDFをビルドする環境については、@kaorun55さんや@ryuzeeさんが紹介してくださっています。

書籍執筆における、継続的なデリバリー - かおるんダイアリー
ReVIEW + Jenkinsでドキュメントを常時ビルドする | Ryuzee.com
コマンドラインからDropboxを操作する方法 (+Jenkinsとの連携) | Ryuzee.com

最近、コミュニティのあるプロジェクトで複数人でドキュメンテーションをすることになったので
是非、これらの環境を構築したいと思いました。まず、最初は費用が掛からない方法で、始めたいと思い、やり方を検討した結果、ドキュメンテーションのツールにSphinxリポジトリにGitHub、ビルドにBuildHiveを利用することにしました。

Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
GitHub · Build software better, together.
BuildHive: Cloud Continuous Integration

これらのツールやサービスを組み合わせると、ドキュメントのソースやビルドされたドキュメントを非公開にしなくても良い場合は非常に手軽に環境を構築することができました。

GitHubを無償で利用する場合は、publicのリポジトリのみ作成可能です。
BuildHiveを利用するとpulbicなGitHubのリポジトリをpushトリガで簡単に自動ビルドすることができます。

BuildHiveは@kaorun55さんが紹介してくださっているCloudBeesと同様にPythonが動作するため、Sphinxを動作させることが可能です。設定方法は以下を参考にさせていただきました。

NBM: CloudBeesさん提供のJenkinsを使ってSphinxドキュメントをビルドする方法

本当に簡単に構築できるので、興味のある方は是非お試しください!