ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Sphinx Theme Getting started Toolchain

Caution

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

Toolchain¶

Here are some concepts you should know before adding the doc toolchain to a project.

Markup language¶

We recommend using reStructuredText markup language to write documentation. Additionally, the toolchain supports Markdown.

Learn more

Sphinx¶

The tool we use to convert restructuredText and Markdown to HTML. Sphinx comes with directives and extensions, which add additional options for formatting the text.

Learn more

Scylla Sphinx Theme¶

All Scylla documentation projects share a theme to have a common look and feel. In addition, Scylla Sphinx Theme preinstalls a set of custom functionalities to make them available for all projects.

Learn more

Multiversion extension¶

We use the third-party extension sphinx-multiversion to build docs for different versions.

Learn more

GitHub¶

Hosts the code and docs source files of Scylla’s projects.

Learn more

GitHub Pages¶

Hosts the HTML version of the docs generated by Sphinx.

Learn more

GitHub Actions¶

Builds and deploys the documentation to GitHub Pages whenever new content is in the GitHub repository default branch. All the repositories deploy the documentation automatically except the repository scylla-docs, which is deployed manually.

Learn more

AWS Amplify¶

Builds a preview site for the docs every time someone sends a pull request that updates the docs folder.

Learn more

Expertrec¶

Crawls all the documentation sites to offer a unified search experience.

Learn more

Was this page helpful?

PREVIOUS
Getting started
NEXT
Installation
  • Create an issue
  • Edit this page

On this page

  • Toolchain
    • Markup language
    • Sphinx
    • Scylla Sphinx Theme
    • Multiversion extension
    • GitHub
    • GitHub Pages
    • GitHub Actions
    • AWS Amplify
    • Expertrec
ScyllaDB Sphinx Theme
  • 1.2
    • 1.8
    • 1.7
    • 1.6
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • Getting started
    • Toolchain
    • Installation
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirections support
    • Search 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
Docs Tutorials University Contact Us About Us
© 2025 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 01 Apr 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
Ask AI