sphinx-uedoc-theme

Unreal Engine documentation look and feel theme for Python Sphinx

You can see the theme in action on the ONLINE DEMO

Installation

Install it via pip

pip install sphinx-uedoc-theme

Usage

In Sphinx conf.py:

...
extensions = ['sphinx_uedoc_theme']
...
html_theme = 'uedoc_theme'
...
html_theme_options = {'put here the values for the options'}
...

Customizable Options

This is a list of all the theme options:

Customizing the Color Scheme

you can customize the color scheme of the theme by overrding the default css variables

The variables are HSL separated values if you want to see the compiled values look the compiled css Heres the compiled css with the default values:

:root {
    --clr-background-h: 0;
    --clr-background-s: 0%;
    --clr-background-l: 100%;
    --clr-primary-h: 0;
    --clr-primary-s: 0%;
    --clr-primary-l: 16%;
    --clr-secondary-h: 197;
    --clr-secondary-s: 92%;
    --clr-secondary-l: 49%;
    --clr-text-primary-h: 0;
    --clr-text-primary-s: 0%;
    --clr-text-primary-l: 100%;
    --clr-text-secondary-h: 0;
    --clr-text-secondary-s: 0%;
    --clr-text-secondary-l: 100%;
    --clr-text-background-h: 0;
    --clr-text-background-s: 0%;
    --clr-text-background-l: 0%;
    --clr-primary-gradient-start: hsla(var(--clr-primary-hsl), 0);
    --clr-primary-gradient-end: hsla(var(--clr-primary-hsl), 0.95);
    --clr-scrollbar: transparent;
    --clr-scrollbar-thumb: hsla(var(--clr-primary-h), var(--clr-primary-s), 82%, 0.6);
}

Development Requisites

If you want to contribuite with the development of the theme you can setup a local development enviroment, these are my suggestion and the one i used to develop the theme.

Requisites

• NPM
• Python 3.7

The theme i developed using SCSS, JS and webpack to bring all the asset to web standars stadands.

So here are the steps to setup a working enviroment:

1. git clone the repository to your local machine
2. cd sphinx-uedoc-theme (navigate to the cloned repo root folder)
3. npm i (to install all the needed dependencies)
4. At this point i suggest to createa python virtual env using a tool of your choice (i use conda to manage my virtual envs)
5. pip install -r requirements.txt (install the python dependencies using pip)
6. Start making changes
7. Use webpack prod or webpack dev to build the theme