Skip to content
Sphinx theme for readthedocs.org
CSS HTML JavaScript Python
Branch: master
Clone or download
agjohnson Merge pull request #807 from readthedocs/agj/format-webpack-js
Run webpack js through Prettier JS formatter
Latest commit feb0beb Aug 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create CODE_OF_CONDUCT.md (#562) Feb 2, 2018
.tx Continuation of adding translations to theme Jul 17, 2019
bin Add a bit more error logging to preinstall check Jul 26, 2019
docs Add more domain doc examples Jul 26, 2019
fonts Change Lato font to webfont (version 2.015) (#639) May 24, 2018
sphinx_rtd_theme Remove "Free document hosting provided by Read the Docs" message Aug 21, 2019
src Merge branch 'master' into style-cpp-domain Jul 26, 2019
tests Adds testing and hopefully a final fix for the empty toctree issue Mar 6, 2017
.gitattributes Fix line endings (#709) Dec 18, 2018
.gitignore Comment on why bourbon-neat is pinned Jul 26, 2019
.readthedocs.yml Replace with requirements file, RTD doesn't handle these patterns well. Jul 25, 2019
.travis.yml Update .travis.yml Mar 7, 2019
Apache-License-2.0.txt Bundle Roboto Slab as a real web font (not just ttf) (#642) May 24, 2018
LICENSE Replace the name 'Dave Snider' with RTD (#572) Mar 19, 2018
MANIFEST.in Merge branch 'master' into master Mar 7, 2019
OFL-License.txt Change Lato font to webfont (version 2.015) (#639) May 24, 2018
README.rst Merge branch 'master' into agj/update-translations-rebase Jul 25, 2019
babel.cfg Updated Babel configurations Apr 17, 2018
package.json Comment on why bourbon-neat is pinned Jul 26, 2019
setup.cfg Continuation of adding translations to theme Jul 17, 2019
setup.py Final doc updates and fix tests Jul 25, 2019
tox.ini Tests: Update to new sphinx & python Oct 5, 2018
webpack.common.js Run webpack js through Prettier JS formatter Jul 26, 2019
webpack.dev.js Run webpack js through Prettier JS formatter Jul 26, 2019
webpack.prod.js Run webpack js through Prettier JS formatter Jul 26, 2019

README.rst

Read the Docs Sphinx Theme

Pypi Version Build Status License Documentation Status

This Sphinx theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is used primarily on Read the Docs but can work with any Sphinx project. You can find a working demo of the theme in the theme documentation

Installation

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

pip install sphinx-rtd-theme

To use the theme in your Sphinx project, you will need to add the following to your conf.py file:

import sphinx_rtd_theme

extensions = [
    ...
    "sphinx_rtd_theme",
]

html_theme = "sphinx_rtd_theme"

For more information read the full documentation on installing the theme

Configuration

This theme is highly customizable on both the page level and on a global level. To see all the possible configuration options, read the documentation on configuring the theme.

Contributing

If you would like to help modify or translate the theme, you'll find more information on contributing in our contributing guide.

You can’t perform that action at this time.