Was this page helpful?
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.
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.
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.
Multiversion extension¶
We use the third-party extension sphinx-multiversion to build docs for different versions.
GitHub¶
Hosts the code and docs source files of ScyllaDB projects.
GitHub Pages¶
Hosts the HTML version of the docs generated by Sphinx.
GitHub Actions¶
Builds and deploys the documentation to GitHub Pages whenever new content is in the GitHub repository default branch.
Expertrec¶
Crawls all the documentation sites to offer a unified search experience.