Sphinx theme for readthedocs.org
CSS HTML JavaScript Python

README.rst

Read the Docs Sphinx Theme

Pypi Version Build Status License Documentation Status

The sphinx_rtd_theme is a sphinx theme designed to look modern and be mobile-friendly. This theme is primary focused to be used on readthedocs.org but can work with your own sphinx projects. To read more and see a working demo head over to readthedocs.org.

Installing

The theme is distributed on PyPI and can be installed with pip:

pip install sphinx_rtd_theme

For more information read the full installing docs here.

Configuration

The sphinx_rtd_theme is highly customizable on both the page level and on a global level. To see all the possible configuration options read the configuring docs here.

Contributing

If you would like to help improve the theme or have more control over the theme in case of a fork please read our contributing guide here.