sphinx な docker コンテナ

sphinx な docker コンテナの使い方を調べた。うん。いい感じ。

 

 

sphinx docker イメージの取得
##############################
sphinx の docker イメージは


このイメージファイルをダウンロードする。

.. code:: rest

$ docker pull sphinxdoc/sphinx-latexpdf

イメージファイルのダウンロードに成功したかどうか確認するには、

.. code:: rest

$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
sphinxdoc/sphinx latest a55aa3f72f43 3 weeks ago 281MB
sphinxdoc/sphinx-latexpdf latest cd800f4f8bf5 3 weeks ago 2.2GB

と表示されていれば成功。

sphinx なプロジェクトの作成
#############################

docker な sphinx を使って sphinx なドキュメントのプロジェクトを作成する。

.. code:: rest

$ docker run --rm -it -v "$PWD:/documents" -e SWITCH_USER=1 -e LOCAL_UID=$(id -u $USER) -e LOCAL_GID=$(id -g $USER) sphinxdoc/sphinx sphinx-quickstart





-it オプションをつけることにより、対話モードで sphinx-quickstart を起動できる。
プロジェクト名、作者名、ドキュメントリリース番号など、対話的ではなく引数で指定することもできる。

.. code rest

$ docker run --rm -it -v "$PWD:/documents" -e SWITCH_USER=1 -e LOCAL_UID=$(id -u $USER) -e LOCAL_GID=$(id -g $USER) sphinxdoc/sphinx my-sphinx-quickstart -p "YourProjectName" -a "John Doe <john.doe@example.com>" -r 1.0


プロジェクトのビルド
######################

初期状態でもサンプルの文書をビルドして PDF や HTML を生成できる。

.. code:: rest

$ docker run --rm -it -v "$PWD:/docs" -e SWITCH_USER=1 -e LOCAL_UID=$(id -u $USER) -e LOCAL_GID=$(id -g $USER) sphinxdoc/sphinx-latexpdf


.. code:: rest

$ docker run --rm -it -v "$PWD:/docs" -e SWITCH_USER=1 -e LOCAL_UID=$(id -u $USER) -e LOCAL_GID=$(id -g $USER) sphinxdoc/sphinx make html