Sphinxをセットアップする

今の時代はGitBookでしょ。
でもSphinxだってできる子です。
とっつきにくいと思われるかもしれませんが、とても簡単です。

かんたんインストール

1. pythonいれます。（すでに入っていれば不要です）

2. 一気にsphinxいれます。

   pip install sphinx commonmark==0.5.4 recommonmark sphinx-autobuild sphinx_rtd_theme 
   sphinxcontrib-mermaid
   

3. 以下のサンプルを適当なフォルダーにcloneします。
   https://github.com/hiraokusoy/sphinx-samples/tree/master/sample1

4. conf.pyの設定を適当に変更します。（変更しなくても使えます）

5. autobuildを起動します。

   sphinx-autobuild source build/html
   

おしまい。

これで、ブラウザでlocalhost:8000にアクセスすると、ビルドされたドキュメントが見れます。
ファイルを修正すると、即座にブラウザに反映されます。
build/html一式をどこかのサーバーに置くなりzip化するなりすれば、他の人にドキュメントを渡せます。
そのフォルダーごとgitで管理もできます。

でもreSTやだ

Markdownが使えます。
埋め込みreSTを使うことで、Markdownの力不足も補えます。
csvで表を書けます。
marmeidで図を描けます。
cacooの図を埋め込むこともできます。

テンプレートの中にサンプルが入っています。

参考

[1] Sphinxを便利にして、みんなに使ってもらいたい
https://qiita.com/pashango2/items/d1b379b699af85b529ce#%E6%95%B0%E5%BC%8F--%E3%82%A4%E3%83%B3%E3%83%A9%E3%82%A4%E3%83%B3%E6%95%B0%E5%BC%8F