1.5. ドキュメントを記述¶
1.5.1. rstファイル¶
後は、もう、ドキュメントの内容をどんどん書いていくだけです!
reStructuredText入門
サイドバーの「ソースコードを表示」を押してみてください。 そのページを表示するための記述を見ることができます。^^
気付きにくくて注意する点としては、 pythonだからだと思うのですが、カラム下げにめっちゃ意味があります。
スペースとタブを混ぜてしまうと、思ってたのと全然違うレイアウトになるので、 必ず、どちらか決めて使ってください。
ミスタッチして先頭にスペースが1個余分に入るだけでも意味合いが全然変わってしまいます。 レイアウトがくずれてたらとにかくスペースの数を数えてください!
1.5.2. toctree¶
toctreeはリンクして、目次を作ります。:
.. toctree:: :maxdepth: 10 ←目次をどこまで掘り下げるか :numbered: ←ナンバリングする ./sphinx/index.rst ←当該ページの直下にぶら下がるページをずらずら書く ./blender.rst (.rstは省略できます) ./three/main.rsttoctreeは、親になるページで自分の子になるページを記述します。
toctreeのリンクから漏れているファイルはHTMLに変換されません。
どこにも繋がってないファイルがあると「make html」したときにWARNINGが表示されます。
また、循環している場合にもWARNINGが表示されます。
1.5.3. エスケープコード¶
エスケープコードは \ です。(円マーク)
「ちょこっとめもφ(◕ ◡ ◕ *)」の、* は、 \* と書いています。
C:\pleiades\python\2\Scriptsの、\は、\\ と書いています。