web-dev-qa-db-fra.com

Comment inclure une table des matières locale dans Sphinx doc?

Comment inclure une table des matières locale dans Sphinx doc?

J'ai essayé

.. toc:: 

Mais cela ne semble pas avoir d'effet: rien n'est inséré dans le document.

Fondamentalement, j'ai besoin de liens vers les sections de la page actuelle à placer à un certain emplacement de chaque page.

Est-ce possible?

42
Edy Bourne

Je ne suis pas sûr à 100% que c'est ce que vous recherchez, mais le .. contents:: la directive peut aider. Par défaut, il vous donnera les en-têtes de la page entière, où que vous placiez la directive. Avec :local: spécifié, il générera une table des matières locale pour les en-têtes ci-dessous où vous placez la directive (pratique pour les tocs de sous-section).

Plus de détails ici: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents

50
morric