Read the Docs Sphinx Theme
This Sphinx theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is commonly used with projects on Read the Docs but can work with any Sphinx project.
Using this theme
- Installation
How to install this theme on your Sphinx project.
- Configuration
Theme configuration and customization options.
- Supported browsers
Supported browser/operating system combinations.
- Supported dependencies
Supported project dependencies, like Python and Sphinx.
Development
- Contributing
How to contribute changes to the theme.
- Development guidelines
Guidelines the theme developers use for developing and testing changes.
- Read the Docs contributor guide
Our contribution guidelines extend to all projects maintained by Read the Docs core team.
- Changelog
The theme development changelog.
- Demo documentation
The theme’s styleguide test environment, where new changes are tested.