python - links - ¿Cómo incluir una tabla de contenido local en Sphinx doc?

sphinx tutorial español

Question

¿Cómo incluir una tabla de contenido local en Sphinx doc?

Lo intenté

.. toc::

Pero eso no parece tener ningún efecto: no se inserta nada en el documento.

Básicamente, necesito enlaces a las secciones de la página actual para ubicarlas en una ubicación determinada de cada página.

es posible?

Answer 1

No estoy 100% seguro de que esto es lo que está buscando, pero la directiva .. contents:: puede ayudar. Por defecto, le dará los encabezados para toda la página, donde sea que coloque la directiva. Con :local: especificado, generará un TOC local para los encabezados debajo de donde colocó la directiva (útil para tocs de subsección).

Más detalles aquí: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents