Skip to main content

The theme used to render documentation

Project description

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

# TODO
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.

# TODO
# 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eon_collective_docs_theme-0.0.1.dev0.tar.gz (1.9 MB view hashes)

Uploaded Source

Built Distribution

eon_collective_docs_theme-0.0.1.dev0-py2.py3-none-any.whl (2.0 MB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page