Sphinx ScyllaDB Theme 1.0 is now released 🥳
Learn more
Menu

Reference Documentation

Submodules

sphinx_scylladb_theme.utils module

sphinx_scylladb_theme.utils.multiversion_regex_builder(versions)

Generates a regex string from a list of versions.

Every documentation project conf.py file uses this function to define the different documentation versions supported.

Parameters

versions (list of str) – A list of versions. Versions could be either branch names or tags.

Returns

The equivalent regular expression.

Return type

str

Module contents

sphinx_scylladb_theme.compute_hide_toc(context)
sphinx_scylladb_theme.compute_toc_tree(toctree, maxdepth, collapse)
sphinx_scylladb_theme.override_rst_epilog(config)
sphinx_scylladb_theme.override_smv_latest_version(config)
sphinx_scylladb_theme.setup(app)

Setup theme

sphinx_scylladb_theme.update_config(app, config)
sphinx_scylladb_theme.update_context(app, pagename, templatename, context, doctree)