A Sphinx theme for the Sheffield University IT Services Research IT documentation pages.
Project description
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:
- Add the theme in the list of
extensions
:extensions = ["tuos_its_sphinx_theme"]
- Make sure the
author
, andproject
variables reflect your organisation name, and project - 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tuos_its_sphinx_theme-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c79e8a0731326baa75753ef48729d34f0d59c1776bf3c434b7e1b678c28b24a4 |
|
MD5 | 34a71fd4d918b2cf7314ab684c2c641e |
|
BLAKE2b-256 | a619dcca2fc702fb0911f1d7be8e1a09169d97a147eedfe17585c686e56e4f0e |
Hashes for tuos_its_sphinx_theme-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e493109b24f0ed033c1ba7853f48a25cf73e3c30a60efdaaf3a6b5017901afb |
|
MD5 | 3c197f93637f2c4ebbf21fdc6c1d702f |
|
BLAKE2b-256 | f5252db980a5132da94ff0c4370029c8825ac764dd27c6f313f2c933684559f9 |