You're viewing documentation for a previous version of Scylla Sphinx Theme. Switch to the latest stable version.
Here are some basic concepts you should know before adding the doc toolchain to a project.
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.
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.
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.
The extension Scylla docs use to build docs for different versions.
Hosts the code and docs source files of Scylla’s proejcts.
Hosts the HTML version of the docs generated by Sphinx.
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.