Read the Docs Sphinx Theme Examples

The goal of this project is to illustrate what documentation looks like with different Sphinx themes when built locally and when built by Read the Docs.

Organization

This repository is organized such that the documentation for different branches is built with a different Sphinx theme.

• master: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/latest/ (Read the Docs theme)
• alabaster: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/alabaster/ (Alabaster theme)
• classic: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/classic/ (a Sphinx built-in theme)
• sphinxdoc: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/sphinxdoc/ (a Sphinx built-in theme)
• scrolls: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/scrolls/ (a Sphinx built-in theme)
• agogo: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/agogo/ (a Sphinx built-in theme)
• traditional: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/traditional/ (a Sphinx built-in theme)
• nature: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/nature/ (a Sphinx built-in theme)
• haiku: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/haiku/ (a Sphinx built-in theme)
• pyramid: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/pyramid/ (a Sphinx built-in theme)
• bizstyle: https://rtd-sphinx-theme-sample-project.readthedocs.io/en/bizstyle/ (a Sphinx built-in theme)

Contents:

• Contributing