Sphinx theme for readthedocs.org

Overview

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.

Issues
  • Swap to using webpack

    Swap to using webpack

    This is pull request is a follow up to the following issue:

    https://github.com/readthedocs/sphinx_rtd_theme/issues/757

    The live reload server is run with yarn start, the production build is built with yarn build.

    opened by SimonBiggs 26
  • Fix a number of issues with Webpack

    Fix a number of issues with Webpack

    A few of these squeezed by QA and testing:

    • badge_only.css was copied to the static output path, it wasn't actually building it seems. Added second entry for this to make it easier.
    • jQuery was not being treated as an external library and was vendored into our JS bundle!
    • Having the fonts in a relative path from CSS ('../fonts'), causes CORS issues. Moved /fonts to /sphinx_rtd_theme/static/css/fonts essentially. See #782
    • The dev server wasn't compiling assets consistently for me, tuned it hopefully
    • This does output an unused js/badge_only.js, which I believe is for using CSS through JS. This is a webpack 4 thing and it can't be removed. I say disregard it for now.

    Requires #807, based on that until it's merged, then can be repointed to master Refs #782

    Improvement 
    opened by agjohnson 21
  • Sphinx deprecation warning

    Sphinx deprecation warning

    Problem

    sphinx_rtd_theme/search.html:20: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a