セクションを定義する

文章を書くときは通常、章、節、項あるいはHTMLで言うならばH1, H2, H3といった、構造を考えて書きます。

文字の上下に線を引くことでセクションとなります。この線にはどんな文字でも使ってよく、それまで使用していない種類の文字を使ったアンダーラインが出てくると、見出しのレベルが一段変わる、というルールになっています。

参考までに、Pythonドキュメントで使っている慣例について紹介しておきます。並んでいる順番に小さな区切りになっていきます。通常は3.のセクションから書くことが多いでしょう。

  1. #: 注意: 上の線をつけて書く
  2. *: 注意: 上の線をつけて書く
  3. =: セクション
  4. -: サブセクション
  5. ^: サブサブセクション
  6. ": パラグラフ

線を引くときは以下の点に注意する必要があります。

  • 文字列と同じかそれ以上の長さである必要があります
  • 下だけは許されますが、上だけは許されません

ノート

日本語のタイトルをつけた場合、同じ数だけ=などを入力しても、数があっていないという警告が発せられる場合があります。これを避けるために、ある程度多めに入力しすると良いでしょう

=========
第1段階
=========

---------
第2段階
---------

~~~~~~~
第3段階
~~~~~~~

前のトピックへ

reST/Sphinxを使うときの最初の一歩

次のトピックへ

リストを書く

このページ