Skip to content

Robpol86/sphinx-multi-theme

Repository files navigation

sphinx-multi-theme

Github-CI Coverage Status Documentation Status Code style: black PyPI

A Sphinx extension that builds copies of your docs using multiple themes into separate subdirectories.

📖 See the documentation at https://sphinx-multi-theme.readthedocs.io

Install

Requires Python 3.6 or greater and Sphinx 4.0 or greater. Not supported on Windows.

pip install sphinx-multi-theme

Example

# conf.py
from sphinx_multi_theme.theme import MultiTheme, Theme

extensions = [
    "sphinx_multi_theme.multi_theme",
]

html_theme = MultiTheme(
    [
        Theme("sphinx_rtd_theme", "Read the Docs"),
        Theme("alabaster", "Alabaster"),
        Theme("classic", "Classic"),
    ]
)
===============
An RST Document
===============

.. multi-theme-toctree::
    :caption: Example Themes