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

Project details


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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file sphinx-multi-theme-1.0.0.tar.gz.

File metadata

  • Download URL: sphinx-multi-theme-1.0.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for sphinx-multi-theme-1.0.0.tar.gz
Algorithm Hash digest
SHA256 320129335b0fd7af4683e06308ba132dcff64f880f7ab042830c47d8244b63fc
MD5 f2c7ebe64425bbc9aad5fdded92d321d
BLAKE2b-256 5056239a587f59493adf572709d67adeff990f6939733e0055011b1643532d1c

See more details on using hashes here.

File details

Details for the file sphinx_multi_theme-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_multi_theme-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9cb424ff4c7b1af84259a356461fa9bd186cbb2c6e051ef4ce4656927a108686
MD5 ec012ef1fd2db7f4c89c28b6202be036
BLAKE2b-256 8e72113f8ea93ee47bdd3a6e5d5b08c20e21c08ffb54d526d80bfc6c648cb70d

See more details on using hashes here.

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