sphinxの見出しで使用する記号の慣例

少し前から sphinx でドキュメントを書くことがあって、その便利さにすっかりハマってしまっています。

ドキュメント書かないといけないのはわかってるけど、書くの面倒だなぁという方はぜひsphinxでドキュメントを書いてみることをお勧めします。

sphinx では、以下の記号がで見出しに使用できます。

= - ` : . ' " ~ ^ _ * + #

文字の種類と見出しのレベルは関係ないので、どの文字でも使用できます。
使用していない種類のアンダーラインが出てくると、見出しのレベルが一段変わる、というルールになっているのですが、これまでは自分ルールで使用していました。

いろいろ見ていると、Pythonドキュメントで使っている慣例があったので、これからはこれを使用してみようかと思います。

• #（オーバーライン付き）：部
• *（オーバーライン付き）：章
• =：セクション
• -：サブセクション
• ^：サブサブセクション
• "：パラグラフ