SphinxドキュメントのためのDockerイメージを公開しました！

Sphinxで生成したドキュメントをWebサーバとして提供するDocker imageを公開しました。

コンセプトは

• 簡単な使い心地
• SphinxのソースはGitから取得する
• SphinxドキュメントのビルドとWebサーバの起動を単一のイメージで完結させる

です。

目次

利用方法

Github もしくは自身のGit サービスにすでに Sphinxのソースを上げている場合はすぐに使い始めることが出来ます。

docker run -p 8080:80 -it dockerrunit/sphinx -r <Sphinxのソースリポジトリ>


# 実行例
docker run -p 8080:80 -it dockerrunit/sphinx -r https://github.com/chmod644/sphinx-example.git

起動後はウェブブラウザで http://localhost:8080/sphinx を開いてください。

その他の引数

最後に -h をつけるとヘルプを見ることができます

docker run -it dockerrunit/sphinx -h

Usage: docker run -p 8080:80 -it dockerrunit/sphinx -r <repository> [option...] 

  -r  Git repository of sphinx
  -b  Branch or Tag to checkout
  -d  Directory of builded html

Browse http://localhost:8080/sphinx

サポートしているSphinxテーマ

現時点では、sphinxに同梱されている標準テーマとsphinx_rtd_themeだけサポートしています。

sphinx_rtd_themeを使いたい場合はdockerrunit/sphinx:sphinx_rtd_themeをlatestイメージの代わりに使ってください。

最新情報

Docker Hub か GitHub に記載していきます。