sphinx用のテンプレート作った

表題通りですが、pythonのドキュメントなどに使われている、ドキュメント作成ツールのsphinxのテンプレートを作りました。

これもselenium同様、適当にDockerに詰め込んでいます。

GitHub - cfm-art/sphinx-docker-template: for Docker Compose.

for Docker Compose. Contribute to cfm-art/sphinx-docker-template development by creating an account on GitHub.

github.com

利用方法

1. Dockerインストール
2. 各種設定を変更
3. 各種ドキュメントを記述
4. docker-compose up

Dockerインストール

Dockerがインストールされている前提です。

※インストールDocker公式サイトに行って、アカウント登録→Dockerインストールです。

各種設定を変更

• documents/source/conf.py
• Dockerfile
• docker-compose.yml

あたりを好みに合わせて変更します。

各種ドキュメントを記述

documents/source/フォルダ以下に、reStructuredTextでドキュメントを記述します。

※設定によってはmarkdownもreStruturedTextとしてビルドするっぽい気がします。

docker-compose up

ターミナルでdocker-compose.ymlがあるフォルダでこれを実行してください。

ビルドを実行します。

※常駐はせずにビルドして終わりますので、-dは不要です。

ビルドに成功した場合は documents/build フォルダにhtmlが作成されます。