« Sphinx、index.rstを makeしてみる | トップページ | UltimateDefragを使ってみる »

toctreeって何だ?

Sphinxのプロジェクトフォルダにある「source」フォルダには、index.rstがあります。ウェブサイトをHTMLで作ったことのある人も、そうでない人も、"index.html" はURLの一部としてよく目にすると思います。通常ウェブサイトを作る時には "index.html" がホームページ(トップページとよく言われますね)として使われます。その元が index.rst です。

index.rst に目次を書いていくと、他のコンテンツへのリンクが自動的にできていくようなイメージです。Sphinx-Users.jp のサイトを見ると、目次のツリーを挿入するための決まり文字として「TOCツリー」の説明があります。

私はここを読んでも目次のイメージをつかめませんでした。.. toctree:: の後に改行して文字列を書いていくとHTMLではどうなるのかが、絵として思い浮かばなかったのです。そこで、デベロッパーに質問してみたら、素晴らしい機能を教えてくれました。渋川よしきさんのウェブサイト(古いバージョンの訳だそうですが、ソースを見る意味では十分役立ちます)にある 「ソースコードを表示」です。

目次の書き方を知るには、目次ページを見るのが良いだろうと、「Sphinxドキュメント目次」のソースコードを表示してみると、確かに「.. toctree::」の後に、一行ずつ文字列が見えます。ソースコードとウェブサイトの表示を比べてみると、リストの一番上のレベルと、toctreeとして書いてある文字列が対応しているようです。(目次:イントロダクション、toctreeの書き方:introのように)

そこで、私は toctree を章立てを作る決まり文字として考えることにしました。

ちなみに Sphinxでは文字コードとしてUTF-8を使うため、ブラウザがIEの場合、ソースコードを表示する時はそのままだと日本語が文字化けします。[表示]-[エンコード]から UTF-8を選択して正しく表示させるか、またはFireFoxのような他のブラウザを使うと良いかもしれません。

次回は、実際に書いた toctree の例を挙げます。

|

« Sphinx、index.rstを makeしてみる | トップページ | UltimateDefragを使ってみる »

Sphinx」カテゴリの記事

コメント

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.f.cocolog-nifty.com/t/trackback/98967/37232928

この記事へのトラックバック一覧です: toctreeって何だ?:

« Sphinx、index.rstを makeしてみる | トップページ | UltimateDefragを使ってみる »