ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.

ScyllaDB Docs ScyllaDB Sphinx Theme Examples TOC

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:

Was this page helpful?

PREVIOUS
Text
NEXT
Topic Box
ScyllaDB Sphinx Theme
  • 1.1
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • Getting Started
    • Toolchain
    • Installation
  • Configuration
    • Template Options
    • Multiversion Options
    • Troubleshooting
  • Commands
  • Deployment
  • Examples
    • Admonitions
    • Collapse
    • Code Blocks
    • Glossary
    • Headings
    • Hero Box
    • Includes
    • Images
    • Links
    • Lists
    • Markdown Support
    • Metadata
    • Panel Box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic Box
    • Versions
  • Upgrade Guides
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the Documentation
    • Contribute to the Sphinx Theme
    • Source Code
  • Create an issue
  • Edit this page

On this page

  • TOC
    • TOC
    • Mini-TOC
Logo
Docs University Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 22 Sep 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.5.1