ScyllaDB University Live | Free Virtual Training Event
Learn more
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
ScyllaDB Docs ScyllaDB Sphinx Theme Getting started Toolchain

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

ScyllaDB Sphinx Theme¶

All ScyllaDB documentation projects share a theme to have a common look and feel. In addition, ScyllaDB 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 ScyllaDB 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.

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

PREVIOUS
Getting started
NEXT
Installation
ScyllaDB Sphinx Theme
  • 1.4
    • 1.4
    • 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.3 to 1.4
    • 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

  • Toolchain
    • Markup language
    • Sphinx
    • ScyllaDB Sphinx Theme
    • Multiversion extension
    • GitHub
    • GitHub Pages
    • GitHub Actions
    • AWS Amplify
    • Expertrec
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 14 Mar 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.4.1