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)
Contributing¶
Contributions to this repository are welcome and encouraged.
All members of our community are expected to follow Read the Docs’ Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.
Adding new themes¶
Adding a new theme to this repository is relatively straight-forward. The steps include:
- Adding the branch name to the theme mapping to conf.py (see branch_to_theme_mapping). The name of the branch should closely follow the theme name.
- Updating the README.rst to link to the docs on Read the Docs
- Create an issue that a maintainer needs to create a new branch on the repository and configure Read the Docs to build docs on the new branch.