sphinx_rtd_theme_github_versions

This theme inherits from sphinx_rtd_theme and adds an entry in the sidebar listing all versions of the documentation on github.io for the current repo

PyPI	pip install sphinx_rtd_theme_github_versions
Source code	https://github.com/DiamondLightSource/sphinx_rtd_theme_github_versions
Documentation	https://DiamondLightSource.github.io/sphinx_rtd_theme_github_versions
Releases	https://github.com/DiamondLightSource/sphinx_rtd_theme_github_versions/releases

How the documentation is structured

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

Tutorials

• Installation
  • Check your version of python
  • Create a virtual environment
  • Installing the library
  • Including in Sphinx Documentation
  • Deployment

How-to Guides

Practical step-by-step guides for the more experienced user.

How-to Guides

• Configure the theme

Explanations

Explanation of how the library works and why it works that way.

Explanations

• How it works
  • Commandline script
  • Javascript population

Reference

Practical step-by-step guides for the more experienced user.

Reference

• Contributing
  • Running the tests
  • Code Styling
  • Documentation
  • Release Process
  • Updating the tools
• Releases

About the documentation

Why is the documentation structured this way?