How to write documentations#

Date: 2024年06月18日

Sphinx#

ドキュメント作成に Sphinx を使用している.

Sphinx は,reStructuredText記法で書かれたテキストファイルを HTML などに変換するツールである. 後述で,Markdown記法にも対応することが可能. 多くのドキュメントで使用され,主に Python Docs(official, numpy, matplotlib, etc.)で使われる.

無料で読める本 Sphinxの使い方