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>'
Google Analytics is disabled by default. Enable it only for production builds; all Quantinuum documentation uses the default measurement ID, or it can be overridden per site:
html_theme_options = {
'enable_analytics': True,
'analytics_id': 'G-YPQ1FTGDL3',
}
When analytics is enabled, the navigation bundle reads the measurement ID from the rendered theme configuration and initializes Consent Mode and Google Analytics.
The local demo remains analytics-free by default. Opt in when building it with:
./build-demo.sh --analytics
This uses the theme's default measurement ID. To test another GA4 property:
./build-demo.sh --analytics-id G-XXXXXXXXXX
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:
2 maintainers
Metadata
2 maintainers
Release files for quantinuum_sphinx 1.12.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| quantinuum_sphinx-1.12.1.tar.gz | 210.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| quantinuum_sphinx-1.12.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 422.9 kB
Release files / quantinuum_sphinx-1.12.1.tar.gz
| Download URL | quantinuum_sphinx-1.12.1.tar.gz |
|---|---|
| Size | 210.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1b3881472e2cb9a70051d57c665df6a89526dac2a3cf8add4d8d329fb5e9c85f
|
|
BLAKE2b-256 checksum How to use checksums |
2c4b462d0630734503edbf472e23234bc936d3eb59e8e71f9b7048963e9b384d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.18 {"installer":{"name":"uv","version":"0.12.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / quantinuum_sphinx-1.12.1-py3-none-any.whl
| Download URL | quantinuum_sphinx-1.12.1-py3-none-any.whl |
|---|---|
| Size | 212.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f332b3ad0a3692792c18271a9a6f33e68230b85adcf4d2e6a1c94552e6070483
|
|
BLAKE2b-256 checksum How to use checksums |
4b175a7996d32eff62c6f74d13a7d43904096171c4703bdb3402a4e256b424cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.18 {"installer":{"name":"uv","version":"0.12.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
