Sphinx ScyllaDB Theme 1.0 is now released 🥳
Learn more
Menu

TOC

These directives create TOCs automatically

TOC

The TOC is automatically generated in sphinx when you build the site.

Each index.rst needs to have a toctree directive in order to build the left side nav menu.

See the template for more details.

.. toctree::
   :maxdepth: 2

Mini-TOC

Every topic which has more than one heading in it needs to have a mini-toc. The Contents directive creates a mini-TOC using the headings you have in the document. You can set the level of headings to include in the TOC. The recommended depth is 2 for H1 and H2.

.. contents::
   :depth: 2
   :local: