https://github.com/robpol86/sphinx-multi-theme
A Sphinx extension that builds copies of your docs using multiple themes into separate subdirectories.
https://github.com/robpol86/sphinx-multi-theme
sphinx sphinx-doc sphinx-extension sphinx-theme
Last synced: 3 months ago
JSON representation
A Sphinx extension that builds copies of your docs using multiple themes into separate subdirectories.
- Host: GitHub
- URL: https://github.com/robpol86/sphinx-multi-theme
- Owner: Robpol86
- License: bsd-2-clause
- Created: 2022-04-03T21:31:54.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-07T21:23:28.000Z (about 2 years ago)
- Last Synced: 2025-01-10T19:24:56.048Z (4 months ago)
- Topics: sphinx, sphinx-doc, sphinx-extension, sphinx-theme
- Language: Python
- Homepage: https://sphinx-multi-theme.readthedocs.io
- Size: 280 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```