docs: Use shared pytket docs config [DRAFT] #228
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Suggestion for using shared docs config using pytket-docs-theming. Follows CQCL/pytket-cutensornet#153 . Still needs approval to be used for other extensions. Also will allow the pytket-phir docs to be added to the tket.quantinuum.com website. Note that the somewhat hacky bash scripts are just for local dev and will not be used in the website build itself. Happy to take suggestions for improvements.
See the build instructions here -> https://github.com/CQCL/pytket-docs-theming/tree/main/extensions#building-the-api-docs-for-pytket-extensions
I've changed a few things... including deleting a makefile and flattening the
docs
directory. I revert these if preferred. I've also used the central config from the theming repo rather than theconf.py
in this repository.This is just a suggestion. I think its more important to update the other extensions.
This allows the the docs to be built locally using the latest quantinuum-sphinx theme (also includes the navbar)
Fixes #
Type of change
Checklist