Was this page helpful?
Caution
You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.
Metadata¶
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 is mainly used for Search Engine Optimization.
.. meta::
:description: The reStructuredText plaintext markup language
:keywords: plaintext, markup language
This would be converted to the following HTML:
<meta name="description"
content="The reStructuredText plaintext markup language">
<meta name="keywords" content="plaintext, markup language">
Full width¶
If set, hides boths sidenavs and makes the content full-width.
:full-width:
Landing page¶
If set, removes all internal paddings from the page.
:landing:
Hide version warning¶
If set, hides the version warning from the page.
:hide-version-warning:
Hide pre content¶
If set, hides the breadcrumbs and contribute button from the page.
:hide-pre-content:
Hide post content¶
If set, hides the prev / next navigation buttons from the page.
:hide-post-content: