Fork of the official readthedocs/sphinx_rtd_theme repo.

work in progress...

Original repo

• https://github.com/readthedocs/sphinx_rtd_theme

About this Fork

Goal is to...

• create a pip installable theme that users can download locally

Steps to use once complete:

• Checkout the official Python docs
• Edit cpython/Doc/config.py Sphinx Configuration file to reference this new python_rtd_theme
• Then build the official Python Docs locally, get a website with a true TOC ("Table of Contents") sidebar.

Related Repos

• https://github.com/python-sidebar/Python-Documentation-Fork-With-TOC
  • cpython fork, used to re-build official docs using Read The Docs theme
• https://github.com/python-sidebar/python-sidebar.github.io
  • GitHub Pages website hosting the output of the fork of the official docs.

Product

Official Docs with TOC Sidebar:

https://python-sidebar/python-sidebar.github.io

Original readme below this line

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 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 edit your conf.py file's html_theme setting:

html_theme = "sphinx_rtd_theme"

See also:

Supported browsers

Officially supported and tested browser/operating system combinations

Supported dependencies

Supported versions of Python, Sphinx, and other dependencies.

Example documentation

A full example of this theme output, with localized strings enabled.

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.