Unreal Engine documentation look and feel theme for Python Sphinx
You can see the theme in action on the ONLINE DEMO
Install it via pip
pip install sphinx-uedoc-theme
In Sphinx conf.py
:
... extensions = ['sphinx_uedoc_theme'] ... html_theme = 'uedoc_theme' ... html_theme_options = {'put here the values for the options'} ...
This is a list of all the theme options:
Option | Default | Description |
---|---|---|
logo | None | this sets the path to the logo on the top right area, the logo image source must be placed in the _static folder of the docs |
quicklinks | None | a dictionary of links to add to the navbar of the theme, sub navigation is possible with 2 level of depth see the demo conf.py for an example |
socials | None | a dictionary of social links with the relative fontaweasome brand icon as key see the demo conf.py for an example |
footerlinks | None | an array of dictionary entries used to add links in the footer area of the theme see the demo conf.py for an example |
show_totop_button | true | show or hide the go to top arrow button in the footer area of the theme |
header_button | None | a dictionary with a link and a name for right button of the navbar of the theme, if left blank no button would be rendered |
no_logo | False | if set to true the default logo is hidden, if no logo is specified the default logo is always shown if you want to hide it set this to true |
header_search | true | whether or not show the search bar in the navigation menu in mobile |
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);
}
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.
- 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:
git clone
the repository to your local machinecd sphinx-uedoc-theme
(navigate to the cloned repo root folder)npm i
(to install all the needed dependencies)- At this point i suggest to createa python virtual env using a tool of your choice (i use conda to manage my virtual envs)
pip install -r requirements.txt
(install the python dependencies using pip)- Start making changes
- Use
webpack prod
orwebpack dev
to build the theme