# ScyllaDB Sphinx Theme > Sphinx Theme for ScyllaDB projects. 2026 ScyllaDB ## Pages - [Home](https://sphinx-theme.scylladb.com/branch-1.6/index.md):
- [Configuration](https://sphinx-theme.scylladb.com/branch-1.6/configuration/index.md):
- [Deployment](https://sphinx-theme.scylladb.com/branch-1.6/deployment/index.md):
- [Contribute](https://sphinx-theme.scylladb.com/branch-1.6/contribute/index.md): We are always looking for those who want to help and appreciate any contribution we can get. - [Upgrade guides](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/index.md):
- [Examples](https://sphinx-theme.scylladb.com/branch-1.6/examples/index.md): This documentation covers the markup convention used for ScyllaDB Docs. - [Getting started](https://sphinx-theme.scylladb.com/branch-1.6/getting-started/index.md):
- [Migrating from 0.x to 1.0](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/0-x-to-1-0.md): This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme. - [Migrating from 1.0 to 1.1](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/1-0-to-1-1.md): This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme. - [Migrating from 1.1 to 1.2](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/1-1-to-1-2.md): This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme. - [Migrating from 1.2 to 1.3](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/1-2-to-1-3.md): This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme. - [Migrating from 1.3 to 1.4](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/1-3-to-1-4.md): This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme. - [Migrating from 1.4 to 1.5](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/1-4-to-1-5.md): This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme. - [Migrating from 1.5 to 1.6](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/1-5-to-1-6.md): This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme. - [Changelog](https://sphinx-theme.scylladb.com/branch-1.6/upgrade/CHANGELOG.md): All notable changes to this project will be documented in this file. - [Admonitions](https://sphinx-theme.scylladb.com/branch-1.6/examples/admonitions.md): At ScyllaDB, we limit the admonitions. Although restructuredText will allow for more, use the follow... - [Code blocks](https://sphinx-theme.scylladb.com/branch-1.6/examples/code-blocks.md): Code block directives are for displaying code. By default the code is copyable and includes a copy i... - [Collapse](https://sphinx-theme.scylladb.com/branch-1.6/examples/collapse.md): Collapsibles are useful to hide large amounts of content. - [Commands](https://sphinx-theme.scylladb.com/branch-1.6/commands.md): Use the command-line interface to run the following commands. - [ScyllaDB docs contributor’s handbook](https://sphinx-theme.scylladb.com/branch-1.6/contribute/contribute-docs.md): If you are reading this guide because you have decided to contribute to ScyllaDB Documentation, than... - [Contribute to the theme](https://sphinx-theme.scylladb.com/branch-1.6/contribute/contribute-theme.md): If you are reading this guide because you have decided to contribute to the ScyllaDB Sphinx Theme, t... - [Glossary](https://sphinx-theme.scylladb.com/branch-1.6/examples/glossary.md): Using the glossary.rst page you can create a glossary. The terms can be entered in any order and it ... - [Headings](https://sphinx-theme.scylladb.com/branch-1.6/examples/headings.md): While Sphinx supports many layers of headings, at ScyllaDB we try to keep the hierarchy limited to 4... - [Hero box](https://sphinx-theme.scylladb.com/branch-1.6/examples/hero-box.md): A custom directive to create a header on the root `index.rst` file. - [Images](https://sphinx-theme.scylladb.com/branch-1.6/examples/images.md): There are two possible directives for images. One is the image directive and the other is the figure... - [Includes](https://sphinx-theme.scylladb.com/branch-1.6/examples/includes.md): An include directive allows you to include the entire contents of one restructured text file directl... - [Installation](https://sphinx-theme.scylladb.com/branch-1.6/getting-started/installation.md): This guide walks you through the steps required to add the documentation toolchain to a ScyllaDB pro... - [Labels](https://sphinx-theme.scylladb.com/branch-1.6/examples/labels.md): A custom role that lets you add labels to your text. - [Links](https://sphinx-theme.scylladb.com/branch-1.6/examples/links.md): There are a few links you can use with different purposes. - [Lists](https://sphinx-theme.scylladb.com/branch-1.6/examples/lists.md): There are two kinds of lists, ordered and unordered. - [Markdown support](https://sphinx-theme.scylladb.com/branch-1.6/configuration/markdown.md): The docs toolchain supports writing documents in Markdown with the help of two extensions: MyST and ... - [Multiversion options](https://sphinx-theme.scylladb.com/branch-1.6/configuration/multiversion.md): The toolchain adds by default the extension [sphinx-multiversion](https://github.com/scylladb/sphinx... - [Page options](https://sphinx-theme.scylladb.com/branch-1.6/configuration/page.md): Add the following annotations at the beggining of `.rst` files to customize the layout of a specific... - [Panel box](https://sphinx-theme.scylladb.com/branch-1.6/examples/panel-box.md): A custom directive to creates boxes on subordinate `index.rst` files. - [Pull requests previews](https://sphinx-theme.scylladb.com/branch-1.6/deployment/previews.md): We use [AWS Amplify](https://docs.amplify.aws/) to build a preview site for the docs every time some... - [Production deployment](https://sphinx-theme.scylladb.com/branch-1.6/deployment/production.md): We use GitHub Pages and GitHub Actions to make the documentation publicly available. - [Quickstart](https://sphinx-theme.scylladb.com/branch-1.6/getting-started/quickstart.md): This guide will show you how to create your first documentation page, list it in the table of conten... - [Redirects support](https://sphinx-theme.scylladb.com/branch-1.6/configuration/redirects.md): With ScyllaDB Sphinx Theme, you can define 301 redirects when moving or deleting a document. - [Search support](https://sphinx-theme.scylladb.com/branch-1.6/configuration/search.md): The toolchain uses the service [Expertrec](https://expertrec.com/) to offer a unified search experie... - [Substitutions](https://sphinx-theme.scylladb.com/branch-1.6/examples/substitutions.md): Substitutions are variables. They are declared in any document and defined in the `conf.py` file, `r... - [Tables](https://sphinx-theme.scylladb.com/branch-1.6/examples/tables.md): We use the List Table directive for tables. - [Tabs](https://sphinx-theme.scylladb.com/branch-1.6/examples/tabs.md): When there are several languages or options available and the reader will use one and keep using tha... - [Template options](https://sphinx-theme.scylladb.com/branch-1.6/configuration/template.md): The following options can be defined in the file `conf.py` per project, using `html_theme_options` s... - [Text](https://sphinx-theme.scylladb.com/branch-1.6/examples/text.md): A paragraph style is markup which applies to an entire paragraph. - [TOC](https://sphinx-theme.scylladb.com/branch-1.6/examples/toc.md): These directives create TOCs automatically - [Toolchain](https://sphinx-theme.scylladb.com/branch-1.6/getting-started/toolchain.md): Here are some concepts you should know before adding the doc toolchain to a project. - [Topic box](https://sphinx-theme.scylladb.com/branch-1.6/examples/topic-box.md): A custom directive that creates graphical boxes (cards) on the root `index.rst` file. - [Versions](https://sphinx-theme.scylladb.com/branch-1.6/examples/versions.md): This is an inline directive which should be used when introducing or deprecating a feature --- For more comprehensive documentation, see [llms-full.txt](https://sphinx-theme.scylladb.com/branch-1.6/llms-full.txt)