Skip to main content

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

Project description

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-multi-theme-1.0.0.tar.gz (10.5 kB view hashes)

Uploaded Source

Built Distribution

sphinx_multi_theme-1.0.0-py3-none-any.whl (12.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page