starling-theme¶
starling-theme
: A Sphinx theme for StARLinG Lab documentation.
A mobile-friendly Sphinx theme based on the design of the StARLinG Lab’s website, as well as sphinx_rtd_theme and the Minimal Mistakes Jekyll Theme.
Quick-start¶
Stable versions are hosted on PyPi, and may be installed with pip
.
# Install with pip
$ pip install starling-theme
# Check installed version
$ python
>>> import starling_theme
>>> print(starling_theme.__version__)
The html_theme
in your Sphinx conf.py
can then be set to use this theme.
# The name of the Pygments (syntax highlighting) style to use.
+ pygments_style = 'monokai'
- pygments_style = 'sphinx'
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
+ html_theme = 'starling_theme'
- html_theme = 'alabaster'
License¶
Copyright © 2018, Alexander L. Hayes
Distributed under the terms of the MIT License. See the LICENSE at the base of the repository for details.