eon-collective-docs-theme 0.0.2.dev0

The theme used to render documentation

Eon Collective Documentation theme

The Eon Collective Documentation theme contains all files required to build a Sphinx extension that provides the theme.

📘 FYI

Supports Python >= 3.8

Assumptions

This guide assumes that you have set up Sphinx in your project. All you need to do is install this theme and include it within your conf.py file.

It is also assumed that you understand Sphinx.

Installation

pip install eon-collective-docs-theme

Usage

In your conf.py file of a Sphinx documentation, specify the "Eon Collective Documentation theme" as an extension.

# include the theme in the list of extensions to be loaded
extensions = ['eon_collective_docs_theme', …]

# select the theme
html_theme = 'eon_collective_docs_theme'

Credits

The Eon Collective Documentation theme is based on the Sphinx Wagtail theme.

Read more about Sphinx Wagtail theme in their documentation.