tuos-its-sphinx-theme 0.0.1

A Sphinx theme for the Sheffield University IT Services Research IT documentation pages.

rcgsheffield Sphinx documentation theme

A Sphinx theme for the Sheffield University IT Services Research IT documentation pages.

Note: This package has not yet been tested, generated or released on Pypi.

Getting started

The source code for this Sphinx theme is available at: https://github.com/rcgsheffield/tuos_its_sphinx_theme. You can use this for your own Sphinx documentation by following the steps below.

Install the package

The latest released version can be installed from the Python Package:

pip install tuos_its_sphinx_theme

Amend your Sphinx conf.py configuration file

To use this Sphinx theme, modify your Sphinx conf.py configuration file as follows:

1. Add the theme in the list of extensions:

   extensions = ["tuos_its_sphinx_theme"]
   

2. Make sure the author, and project variables reflect your organisation name, and project
3. Set html_theme = "tuos_its_sphinx_theme"

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.