YAMAGUCHI::weblog

土足で窓から失礼いたします。今日からあなたの息子になります。 当年とって92歳、下町の発明王、エジソンです。

サイドバーでtoctreeの深さを変更する

はじめに

こんにちは、Sphinx-Users.jpの大声担当です。今日はSphinx三昧ですが、ちょっとはまったのでメモ。

toctreeの深さを変更する

Sphinxで大事なのはtoctreeの存在ですね。index.rstにはtoctreeディレクティブがあってmaxdepthオプションをつければ深さが変更出ました。

目次:

.. toctree::
   :maxdepth: 2

   hoge
   fuga

しかし、この各ページのtoctreeの深さはここでは変えられません。じゃあどうするかと言うと、各ファイルの最上部にtocdepthオプションを書くだけです。簡単ですね。

.. -*- coding: utf-8 -*-
:tocdepth: 2

=================
 ここから見出し
=================

さりげなくドキュメントに載ってるオプションなので気が付きませんでした。

追記

このオプションはサイドバーtoctreeにはちゃんと反映されていいんですが、index.rstのtoctreeにnumberedオプションを与えていた場合に、tocdepthを指定したファイルでは見出しのナンバリングが指定した深さ以降がうまくいかないという事象が出ています。