Was this page helpful?
Caution
You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.
ToolchainCopy
Here are some concepts you should know before adding the doc toolchain to a project.
Markup languageCopy
We recommend using reStructuredText markup language to write documentation. Additionally, the toolchain supports Markdown.
SphinxCopy
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.
ScyllaDB Sphinx ThemeCopy
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.
Multiversion extensionCopy
We use the third-party extension sphinx-multiversion to build docs for different versions.
GitHubCopy
Hosts the code and docs source files of ScyllaDB projects.
GitHub PagesCopy
Hosts the HTML version of the docs generated by Sphinx.
GitHub ActionsCopy
Builds and deploys the documentation to GitHub Pages whenever new content is in the GitHub repository default branch.
ExpertrecCopy
Crawls all the documentation sites to offer a unified search experience.