ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

You're viewing documentation for an unstable version of ScyllaDB Sphinx Theme. Switch to the latest stable version.

ScyllaDB Sphinx Theme Examples Substitutions

Substitutions¶

Substitutions are variables. They are declared in any document and defined in the conf.py file, rst_prolog setting.

Caution

Do not use substitutions in headings. The reason is the text that replaces the variable may be longer than the line that is over or below the text and this will produce an error.

Default substitutions¶

Projects using the theme can use the following substitutions:

  • |v| for

  • |x| for

Substitutions within code blocks¶

To add substitutions within Code blocks, pass the option :substitutions: to the code-block directive.

For example:

.. code-block::
  :substitutions:

  |rst|

Renders as:

restructuredText
PREVIOUS
Panel box
NEXT
Tables
  • master
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Labels
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.2 to 1.3
    • Migrating from 1.1 to 1.2
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
  • Create an issue
  • Edit this page

On this page

  • Substitutions
    • Default substitutions
    • Substitutions within code blocks
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 13 Dec 2022.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.3.4