quantinuum_sphinx 0.3.0

No project description provided

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

In conf.py add:

extensions ['quantinuum_sphinx']
html_theme = 'quantinuum_sphinx'
html_favicon = '<path to your favicon file>'

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: