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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quantinuum_sphinx-1.12.0.tar.gz.
File metadata
- Download URL: quantinuum_sphinx-1.12.0.tar.gz
- Upload date:
- Size: 210.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2e393227238b0c0797405bb3f10a4f1c448d91595dae13e29476b1ac128dcf55
|
|
| MD5 |
ee64cd247bd85ce4d5124b83d49e350e
|
|
| BLAKE2b-256 |
d7e16e3e123c2f8942ee0b395c4b29904e0025f79662bf74d97855b65cc8d810
|
File details
Details for the file quantinuum_sphinx-1.12.0-py3-none-any.whl.
File metadata
- Download URL: quantinuum_sphinx-1.12.0-py3-none-any.whl
- Upload date:
- Size: 212.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30eadb3f8003f5e76893ce8b5cfb64f24b491df22bf5ce48e0e9c1697b3d41c2
|
|
| MD5 |
c66804be2450eebd741cc5e78313e4ce
|
|
| BLAKE2b-256 |
14f777484bec86dee9ad549abbb4343b245943141e535b8ee5d132ba1aadc8aa
|
