Sphinxに目次をつける

[ページ内の目次を作りたい] では目次をつける方法が紹介されています。 それを見本にして実際に目次を付けてみました。 目次は contents ディレクティブを使います。

.. -*- coding: utf-8 -*-

.. contents:: 目次
   :depth: 3
   :local:
   :backlinks: entry

各ページには次のコードを埋め込んでいます。 結果はこのページの目次をご覧ください。

contents ディレクティブ

.. contents::

そのページにあるセションを集めてリンク集を作成します。 引数にはタイトルを指定できます。 例えば 目次 などがいいですが、 オリジナリティを発揮してもいいかも知れません( お品書き とか)。

オプションには次のものがあります。

:depth: <NUM>

何階層目までのセクションを対象にするかを指定できます。 <NUM> には1以上の整数を指定します。

:local:

指定すると contents ディレクティブより 後にあるセクションだけを対象にします。 途中で目次を入れたいときなどに便利です。

:backlinks: [arg]

セクションを目次に戻るためのバックリンクにします。 [arg] には次のどれかを指定します。 デフォルトは entry です。

  • entry

    各項目に対してバックリンクを作ります。

  • top

    目次のタイトルに対してバックリンクを作ります。

  • none

    各項目に対してバックリンクを作りません。

[ページ内の目次を作りたい]http://sphinx-users.jp/reverse-dict/writing/contents.html

目次

前のトピックへ

Tips

次のトピックへ

Sphinxで打ち消し線を引く

このページ

inserted by FC2 system