OpsLab Operation Lab

2020-06-10 Sphinxで 大量にドキュメントを手軽に作るための工夫

2020年06月10日開催の”みんなのPython勉強会#58”での発表資料です。

Sphinxは、知識や経験のインプットとアウトプットを構造化できる強力なツールです。時間が無いときは簡単な構造でメモしておき、時間が取れるときにしっかり構造化してあげることで、自分の暗黙的な知識や物の見方がみるみる構造化されていきます。

日本UNIXユーザ会 2010年12月勉強会「ドキュメントを作りたくなってしまう魔法のツール Sphinx」(講師: 渋川さん、山口さん、清水川さん)をきっかけにSphinxを使いはじめ、年間数千の構造化ドキュメントを書くなかでやってきた「Sphinxを使う上での工夫」についてお話ししました。

更に今回は、普段自分がSphinxを使う上での工夫(自動化している部分など)をデモを交えて紹介しました。