Read the Docsは主にSphinxを使ってドキュメントを生成しホスティングしてくれるサービスで、 GitHubのレポジトリと連携して自動でドキュメントを作成公開してくれたりします。
しばらく前からRead the Docsを使ってるレポジトリで貼ってるバッチがfailを示して
いたのですがそれの原因がわかったので直しました。
Read the Docs
Read the Docsはオープンソースコミュニティーのためのドキュメントホスティングサービスで、
Sphinx というPython製のドキュメントビルダーを使って ドキュメントを生成し公開することが出来ます。
SphinxはPythonの公式ドキュメントを作るのにも使われているものです。
GitHubにあるレポジトリのツールのドキュメントなどで、 下みたいなのを見たことがあるかもしれません。
これはSphinxを使って作られたもので、大概のものはRead the Docsを通じて 公開されています。
Sphinxの使い方やRead the Docsを使ってGitHubのレポジトリと連携する方法については以下を参照。
ビルドが失敗する
結構前からレポジトリに貼ってあるバッジが失敗を示していたので 気にはなっていたのですが、 それほどドキュメントを変更しているわけでもないのでとりあえず 公開はされていたため無視していました。
調べてみると昨年11月頃からのビルドがすべて失敗していました。
今回ちょっとちゃんと見てみようと思って探してみたところ以下の様な Issueを発見。
要はプロジェクト(レポジトリ)にsetup.pyがないと失敗する、ということ。
実際に、Read the Docsの失敗しているレポジトリの管理ページに行ってみると ビルドのところで
python: can't open file 'setup.py': [Errno 2] No such file or directory
といったエラーで失敗していることがわかります。
これを回避するためにはsetup.pyを用意しても良いのですが、 それも必要ない場合があります。(そもそもPythonのプロジェクトじゃないとか。)
その場合、Read the Docs内で変更したいプロジェクトのページに行って、 管理高度な設定 (もしくは表示されているAdvanced Settings)へ行き、
Install your project inside a virtualenv using setup.py install
のところについているチェックを外します。
これでsetup.pyを使わなくなるので失敗しなくなります。
久々にRead the Docsを見てみて
Read the Docsの管理ページに久しぶりに行ってみましたが、 以前はこの様な管理の項目が豊富にあったかな？と思うくらいいろいろと設定がありました。
ビルドが失敗したときにメールで知らせる設定などもできるようになっています。 (多分以前もあったのだろうけども。。。)
Domain設定などで独自ドメインにすることも可能なようです。