Was this page helpful?
Caution
You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.
Add the following annotations at the beggining of .rst files to customize the layout of a specific page.
Adds a description to a document. This description displayed in search engines results page.
For example:
.. meta::
:description: The reStructuredText plaintext markup language
:keywords: plaintext, markup language
Results in the following HTML:
<meta name="description"
content="The reStructuredText plaintext markup language">
<meta name="keywords" content="plaintext, markup language">
If set, makes the content full-width.
:full-width:
If set, makes the content within the div with class landing_content float on top of the hero box.
:landing:
If set, hides the breadcrumbs from the page.
:hide-pre-content:
If set, hides the prev / next navigation buttons from the page.
:hide-post-content:
If set, hides the primary sidebar from the page.
:hide-sidebar:
If set, hides the secondary sidebar from the page.
:hide-secondary-sidebar:
If set, hides the version warning from the page.
:hide-version-warning:
Excludes doctools.js from specific documentation pages.
Required to make the toolchain compatible with Swagger UI.
:exclude-doctools:
Was this page helpful?