Page optionsCopy

DescriptionCopy

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 widthCopy

If set, makes the content full-width.

:full-width:

Landing pageCopy

If set, makes the content within the div with class landing_content float on top of the hero box.

:landing:

Hide pre contentCopy

If set, hides the breadcrumbs from the page.

:hide-pre-content:

Hide post contentCopy

If set, hides the prev / next navigation buttons from the page.

:hide-post-content:

Hide sidebarCopy

If set, hides the primary sidebar from the page.

:hide-sidebar:

Hide secondary sidebarCopy

If set, hides the secondary sidebar from the page.

:hide-secondary-sidebar:

Hide version warningCopy

If set, hides the version warning from the page.

:hide-version-warning:

Exclude doctoolsCopy

Excludes doctools.js from specific documentation pages.

Required to make the toolchain compatible with Swagger UI.

:exclude-doctools: