(c) Copyright 2018 SUSE LLC
SUSE branding for documentation built with Sphinx
In order to automatically install the theme, do the following
- Checkout this repository:
git checkout https://github.com/SUSE/suse-sphinx-theme.git - Install:
python setup.py install - Change the theme name in your
conf.py:html_theme = 'suse_sphinx_theme' - Start building with the new theme
make html
To use the SUSE Sphinx theme, do the following:
- Copy the suse_sphinx_theme folder from this repo to the base directory for your Sphinx documentation
- Open conf.py and set
html_theme = 'suse_sphinx_theme',html_theme_path = ['.'], andhtml_theme_options = {}if they are not already set - Rebuild your documentation (typically
make clean html)
This theme is derived from the openstackdocstheme at https://github.com/openstack/openstackdocstheme , and is heavily modified.
Building the upstream OpenStack docs with the SUSE theme is very similar to the Manual Installation described above:
- Checkout the project with the desired docs (for example:
git clone git://git.openstack.org/openstack/nova) - Build the local project normally (typically
tox -edocs), see the local project documentation for details (e.g. doc/source/contributor/development-environment.rst for nova) - Within the docs folder of the project, update conf.py and set
html_theme = 'suse_sphinx_theme'and add'suse_sphinx_theme',to the extensions list (conf.py is typically under doc/source) - Manually install the theme into the tox environment, this will vary a little depending on where the
suse_sphinx_themeis cloned, for example (from the Nova top level folder in this case).tox/docs/bin/pip install -e ~/upstream/suse-sphinx-theme/ - re-run the tox build job
tox -edocs - the output of the Nova doc build is under
doc/build/html, other projects may output to a different location