README.md

Quantinuum Sphinx

This repo contains templates and static assets that are intended to customize the theme furo.

Using the templates in your Sphinx configuration

Add the following git URL as a submodule in the same directory as conf.py

git submodule add -b dist https://github.com/CQCL/quantinuum-sphinx.git

In conf.py add:

html_theme = "furo"
templates_path = ["quantinuum-sphinx/_templates"]
html_static_path = ['quantinuum-sphinx/_static', '_static']
html_favicon = 'quantinuum-sphinx/_static/assets/quantinuum_favicon.svg'

Create a file ./_static/nav-config.js containing:

const navConfig = {
    "navTextLinks": [
        {
            "title": string,
            "href": string,
        },
    ],
    "navProductName": string,
    "navIconLinks": [
        {
            "title": string,
            "href": string,
            "iconImageURL": string (i.e. "_static/assets/github.svg"),
        },
    ],
}

Rebuild your docs and you should have a navbar: