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

secretbase.log

コードはすべてNYSLです

Read The Docs (Sphinxドキュメントホスティングサービス) が便利なので紹介

Sphinxドキュメントのリポジトリを指定するとビルドとHTMLサイトのホスティングをしてくれるサービス Read the Docs を試してみました。

お試し

下記2つのリポジトリ試してみました。

リポジトリ Read The Docs でできたサイト
https://bitbucket.org/devstart/eclipse-cheatsheet http://eclipse-cheatsheet.readthedocs.org/en/latest/index.html
https://bitbucket.org/cointoss1973/sphinx-example http://sphinx-example.readthedocs.org/en/latest/index.html

リポジトリの内容がビルドされます。bitbucketにpushしたら更新されるように設定ができます。



セットアップ方法の紹介

サインアップしましょう

http://readthedocs.org/ サイトにアクセスします。Sign Upをクリック
f:id:cointoss1973:20120917172121p:plain

Username と メールアドレスとパスワードを入力
f:id:cointoss1973:20120917172457p:plain

メールが届くので、activateします
f:id:cointoss1973:20120917172529p:plain


login すると下記のような画面となります

f:id:cointoss1973:20120917172546p:plain


import でリポジトリ(Githubやbitbucket)を登録する

f:id:cointoss1973:20120917172559p:plain

Name と Repo と Repotype を設定したら後は デフォルトでOKです
f:id:cointoss1973:20120917172629p:plain


手動でビルドしてみましょう

f:id:cointoss1973:20120917172806p:plain


bitbucket と ReadTheDocsの連携

bitbucket側の Admin → Services で ReadTheDocs を追加する
f:id:cointoss1973:20120917172816p:plain


連携の確認

bitbucket に push するとトリガがかかりビルド開始されます(結構速い)f:id:cointoss1973:20120917172929p:plain


更新されました!
f:id:cointoss1973:20120917173538p:plain


dashboardで状況が確認できます

f:id:cointoss1973:20120917172942p:plain


簡単ですね。


感想

  • 一度公開されると、それ移行ビルドは早い。リポジトリにpushするとこの例では5秒後には

更新されていました。

  • 最初の公開までに2時間程度かかることがありました。しばらく待ってみましょう。すぐ公開されることもあります。
  • 検索窓がありますが、検索してもヒットしないです。こんなものでしょうか?