===================== ScyllaDB Sphinx Theme

.. image:: https://github.com/scylladb/sphinx-scylladb-theme/actions/workflows/docs-pages.yaml/badge.svg :target: https://github.com/scylladb/sphinx-scylladb-theme/actions/workflows/docs-pages.yaml

The documentation toolchain for ScyllaDB projects.

.. image:: https://github.com/scylladb/sphinx-scylladb-theme/blob/master/docs/source/deployment/images/preview.png

Features

Shared Design

All ScyllaDB documentation sites share a common look and feel.

Multiversion Support

Build docs for different versions of your project.

GitHub Pages Support

Automatically publish documentation to GitHub Pages.

For more information about the stack, see Toolchain <https://sphinx-theme.scylladb.com/stable/getting-started/toolchain.html>_.

Installation

To add the toolchain to a ScyllaDB project, see the Getting Started <https://sphinx-theme.scylladb.com/stable/getting-started/index.html>_ section of our docs.

Usage

For more documentation, see sphinx-theme.scylladb.com <https://sphinx-theme.scylladb.com>_.

License

Copyright (c) 2020-present ScyllaDB Licensed under the Apache License 2.0 <LICENSE>_.