rum-docs-theme 2020.6

The Sphinx theme for Rum docs and related projects

This is the theme for the Rum documentation.

It is a fork of python-docs-theme, with modifications to suit the Rum programming language.

The forked version of python-docs-theme is licensed under the Python Software Foundation License (PSFL). Any modifications made are licensed under the Mozilla Public License, version 2 (MPL 2.0).

Copies of the PSFL and the MPL 2.0 are included with this project at LICENSE_PSFL and LICENSE_MPL respectively.

To use this theme:

1. Create and activate a virtual environment:

   $ python -m venv env
   $ source env/bin/activate

2. Install python-docs-theme using pip:

   (env)$ python -m pip install rum-docs-theme