https://github.com/cqcl/quantinuum-sphinx
Quantinuum branded templates and assets for Sphinx documentation.
https://github.com/cqcl/quantinuum-sphinx
Last synced: about 1 year ago
JSON representation
Quantinuum branded templates and assets for Sphinx documentation.
- Host: GitHub
- URL: https://github.com/cqcl/quantinuum-sphinx
- Owner: CQCL
- Created: 2024-07-01T12:55:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T10:49:50.000Z (over 1 year ago)
- Last Synced: 2025-02-06T21:45:55.380Z (over 1 year ago)
- Language: HTML
- Size: 1.24 MB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quantinuum Sphinx
This repo contains templates and static assets that are intended to customize the theme [furo](https://pradyunsg.me/furo/).
### Using the templates in your Sphinx configuration
Add the following git URL as a submodule in the same directory as `conf.py`
```bash
git submodule add -b dist https://github.com/CQCL/quantinuum-sphinx.git
```
In `conf.py` add:
```python
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:
```js
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:
