work in progress...

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

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.

• 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.

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

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"

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.

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