https://github.com/cqcl/pytket-docs-theming
Shared configuation files for pytket documentation
https://github.com/cqcl/pytket-docs-theming
Last synced: 8 months ago
JSON representation
Shared configuation files for pytket documentation
- Host: GitHub
- URL: https://github.com/cqcl/pytket-docs-theming
- Owner: CQCL
- Created: 2024-08-23T14:35:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-25T17:34:40.000Z (about 1 year ago)
- Last Synced: 2025-05-07T04:48:11.377Z (about 1 year ago)
- Language: Python
- Homepage: https://docs.quantinuum.com/tket
- Size: 214 KB
- Stars: 2
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pytket-docs-theming
Docs configuration for docs.quantinuum.com/tket based on the [Quantinuum-sphinx](https://github.com/CQCL/quantinuum-sphinx) theme.
This repository is intended to be used as a git submodule in documentation source repositories.
```shell
git submodule add -b main https://github.com/CQCL/pytket-docs-theming.git
```
## Contents
Contains a single source of truth for the following docs config
1. Sphinx configuration - ([conf.py](https://github.com/CQCL/pytket-docs-theming/blob/main/conf.py))
2. A `_static` directory. This currently contains the Quantinuum favicon.
3. Python packages required to build the docs for the pytket extensions modules. These are specified in [pyproject.toml](https://github.com/CQCL/pytket-docs-theming/blob/main/extensions/pyproject.toml) and [poetry.lock](https://github.com/CQCL/pytket-docs-theming/blob/main/extensions/poetry.lock) (see the [README](https://github.com/CQCL/pytket-docs-theming/tree/main/extensions#building-the-api-docs-for-pytket-extensions) for instructions).