Was this page helpful?
Caution
You're viewing documentation for an unstable version of ScyllaDB Sphinx Theme. Switch to the latest stable version.
Page options¶
Add the following annotations at the beggining of .rst files to customize the layout of a specific page.
Description¶
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">
Full width¶
If set, makes the content full-width.
:full-width:
Landing page¶
If set, makes the content within the div with class landing_content float on top of the hero box.
:landing:
Hide pre content¶
If set, hides the breadcrumbs from the page.
:hide-pre-content:
Hide post content¶
If set, hides the prev / next navigation buttons from the page.
:hide-post-content:
Hide version warning¶
If set, hides the version warning from the page.
:hide-version-warning:
Exclude doctools¶
Excludes doctools.js from specific documentation pages.
Required to make the toolchain compatible with Swagger UI.
:exclude-doctools: