Sphinx ScyllaDB Theme 1.0 is now released 🥳
Learn more
Menu

Toolchain

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

Markup language

Most docs are written in RestructuredText. RestructuredText is a file format for textual data used primarily for technical documentation.

Alternatively, you can also use MarkDown to create content pages.

Learn more

Sphinx

The tool we used to converts restructuredText and Markdown to HTML. Sphinx also has directives and extensions to add additional options for formatting the text.

Learn more

Scylla Sphinx Theme

The theme all Scylla documentation projects share to have a common look and feel. It also adds a set of custom functionallities available to make them available to all projects.

Learn more

Multiversion Extension

The extension Scylla docs use to build docs for different versions.

Learn more

GitHub

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

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 every time there is new content. All the repositories deploy the documentation automatically except the repository scylla-docs, which is deployed manually.

Learn more