Scylla University Live | Free Virtual Training Event
Learn more
Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

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

Scylla Sphinx Theme Examples Includes

Includes¶

An include directive allows you to include the entire contents of one restructured text file directly into another. This is the easiest way to control content re-use.

When given an absolute path, the directive takes it as relative to the root of the source directory. It is Scylla practice to place global include files in the rst_include directory.

For example, here are some very commonly used include statements:

.. include:: /rst_include/scylla-commands-stop-index.rst
.. include:: /rst_include/scylla-commands-start-index.rst
.. include:: /rst_include/scylla-commands-restart-index.rst

Literal include¶

If the file you want to include is not restructuredText, you can use the Literal Include directive. This adds the page cited as a code-block.

For example:

.. literalinclude:: ../conf.py
   :lines: 1-10

Gets the conf.py file from the parent directory and displays the first 10 lines.

# -*- coding: utf-8 -*-
import os
import sys
import warnings
from datetime import date

from sphinx_scylladb_theme.utils import multiversion_regex_builder

sys.path.insert(0, os.path.abspath(".."))

PREVIOUS
Hero box
NEXT
Images
  • master
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirections support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • 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

  • Includes
    • Literal include
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 03 May 2022.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.2.1