スフィンクスの紹介

 体系的なドキュメントをまとめたいとき、 Sphinx(以下、スフィンクス)は有力な選択肢である。

sphinx.png

 EmacsのOrg-modeで原稿を用意し、 Pandocと連携してRSTに変換し、 Sphinxでビルドしてドキュメントを作成する。

スフィンクスを導入する方法

 Pythonのパッケージを管理ツールである pip を利用し、 必要なパッケージをインストールする。

sudo -H pip3 install sphinx
sudo -H pip3 install sphinx_rtd_theme

 インストールできたアプリのバージョンを確認する。

pip3 show sphinx
pip3 show sphinx_rtd_theme

GitHub Pagesでドキュメントを公開する

 Sphinx実践入門として、GitHub Pagesで公開を開始した。 このドキュメントの中で、実現方法を紹介していく予定である。