Skip to main content

UTLCo documentation Sphinx theme

Project description

Very simple Sphinx theme derived from sphinx13 which is used for official Sphinx documentation.

There are a few small differences, mainly in colors and header styling.

Some basic options have been added as well.

How to use

Install the theme from GitHub:

pip install https://github.com/utlco/utl-sphinx-theme/archive/refs/heads/main.zip

Add the following line to your conf.py:

html_theme = 'utl_sphinx_theme'

To change the theme options (also in conf.py):

html_options = {
    'title': 'MyTitle',
    'logo': '_static/my-logo.svg',
}

By default it will use the logo image _static/logo.svg.

Project details


Release history Release notifications | RSS feed

This version

0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

utl_sphinx_theme-0.2.tar.gz (7.3 kB view hashes)

Uploaded Source

Built Distribution

utl_sphinx_theme-0.2-py3-none-any.whl (7.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page