User Guide¶

This guide is meant to provide a reasonable introduction into building documentation with stable versions of this theme.

If you are looking for information on how to develop this theme further, see the Developer Guide.
If you are looking for a more general tutorial on Sphinx, the Official Sphinx Quickstart guide may be helpful.

Sections¶

TL;DR (Too Long Didn’t Read)¶

# Install sphinx and the theme
pip install sphinx starling-theme

# Run sphinx-quickstart and follow the prompts
mkdir docs; cd docs
sphinx-quickstart

# Overwrite the html_theme in conf.py and run `make`
make html