web-dev-qa-db-ja.com

ローカルの目次をSphinxドキュメントに含める方法は?

ローカルの目次をSphinxドキュメントに含める方法は?

私は試した

.. toc:: 

しかし、それは何の効果もないようです:何もドキュメントに挿入されません。

基本的に、現在のページのセクションへのリンクを各ページの特定の場所に配置する必要があります。

これは可能ですか?

42
Edy Bourne

これがあなたが探しているものかどうかは100%わかりませんが、.. contents::ディレクティブが役立つ場合があります。デフォルトでは、ディレクティブをどこに置いても、ページ全体の見出しが表示されます。 :local:指定すると、ディレクティブを配置した場所の下の見出しにローカルTOCが生成されます(サブセクションtocsに便利)。

詳細はこちら: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents

50
morric