Menu
How to include a local table of contents into Sphinx doc?
I tried
.. toc:: But that doesn't seem to have any effect: nothing is inserted in the document.
Basically I need links to the sections in the current page to be placed at a certain location of each page.
Is this possible?
452
The toctree directive is the central element. Note. Simple “inclusion” of one file in another can be done with the include directive.
To support Markdown-based documentation, Sphinx can use MyST-Parser. MyST-Parser is a Docutils bridge to markdown-it-py, a Python package for parsing the CommonMark Markdown flavor.
I'm not 100% sure this is what you're looking for, but the .. contents:: directive may help. By default, it'll give you the headings for the whole page, wherever you put the directive. With :local: specified, it will generate a local TOC for the headings below where you put the directive (handy for sub-section tocs).
.. contents:: Table of Contents :depth: 3 More details here: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents
127
I had more luck with:
.. contents:: Table of Contents :depth: 1 :local: :backlinks: none The backlinks gets rid of the annoying links back from the headings to the toc.
39
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
