Was this page helpful?
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.
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.
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.
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 Scylla’s 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.
All the repositories deploy the documentation automatically except the repository scylla-docs, which is deployed manually.
AWS Amplify¶
Builds a preview site for the docs every time someone sends a pull request that updates the docs folder.
Expertrec¶
Crawls all the documentation sites to offer a unified search experience.