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 an unstable version of ScyllaDB Sphinx Theme. Switch to the latest stable version.

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.

.. toctree::
   :maxdepth: 2

For more details, see toctree documentation.

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:
PREVIOUS
Text
NEXT
Topic box
  • master
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Labels
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.2 to 1.3
    • Migrating from 1.1 to 1.2
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
  • Create an issue
  • Edit this page

On this page

  • TOC
    • TOC
    • Mini-TOC
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 13 Dec 2022.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.3.4