Metadata-Version: 2.1
Name: sphinx-multi-theme
Version: 1.0.0
Summary: A Sphinx extension that builds copies of your docs using multiple themes into separate subdirectories.
License: BSD-2-Clause
Author: Robpol86
Author-email: robpol86@gmail.com
Requires-Python: >=3.6
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: MacOS X
Classifier: Environment :: Plugins
Classifier: Environment :: Win32 (MS Windows)
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Requires-Dist: Sphinx (>=4.0.0)
Requires-Dist: dataclasses; python_version < "3.7"
Requires-Dist: funcy
Requires-Dist: seedir
Project-URL: documentation, https://sphinx-multi-theme.readthedocs.io
Project-URL: repository, https://github.com/Robpol86/sphinx-multi-theme
Description-Content-Type: text/markdown

# sphinx-multi-theme

[![Github-CI][github-ci]][github-link]
[![Coverage Status][codecov-badge]][codecov-link]
[![Documentation Status][rtd-badge]][rtd-link]
[![Code style: black][black-badge]][black-link]
[![PyPI][pypi-badge]][pypi-link]

[github-ci]: https://github.com/Robpol86/sphinx-multi-theme/actions/workflows/ci.yml/badge.svg?branch=main
[github-link]: https://github.com/Robpol86/sphinx-multi-theme/actions/workflows/ci.yml
[codecov-badge]: https://codecov.io/gh/Robpol86/sphinx-multi-theme/branch/main/graph/badge.svg
[codecov-link]: https://codecov.io/gh/Robpol86/sphinx-multi-theme
[rtd-badge]: https://readthedocs.org/projects/sphinx-multi-theme/badge/?version=latest
[rtd-link]: https://sphinx-multi-theme.readthedocs.io/en/latest/?badge=latest
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]: https://github.com/ambv/black
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-multi-theme.svg
[pypi-link]: https://pypi.org/project/sphinx-multi-theme

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.

```shell
pip install sphinx-multi-theme
```

## Example

```python
# 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"),
    ]
)
```

```rst
===============
An RST Document
===============

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

```

