Skip to main content

A clean customisable Sphinx documentation theme.

Project description

neocrym-sphinx-theme

This is a modified version of the Furo theme for internal use at Neocrym.

Differences from Furo

Absolute URLs for logos and favicons

The light_logo and dark_logo keys in the html_theme_options variable are ABSOLUTE URLs. Do not use relative URLs.

For example, this is an example conf.py that sets a light and dark logo:

html_theme_options = dict(
    light_logo="https://static.neocrym.com/images/scalarstop/v1/1x/scalarstop-wordmark-color-black-on-transparent--1x.png",
    dark_logo="https://static.neocrym.com/images/scalarstop/v1/1x/scalarstop-wordmark-color-white-on-transparent--1x.png",
    sidebar_hide_name=True,
)

The html_favicon variable also now only accepts absolute URLs.

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

neocrym_sphinx_theme-0.0.7.tar.gz (55.6 kB view hashes)

Uploaded Source

Built Distribution

neocrym_sphinx_theme-0.0.7-py3-none-any.whl (99.3 kB view hashes)

Uploaded 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