Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Use shared pytket docs config [DRAFT] #228

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

CalMacCQ
Copy link
Collaborator

@CalMacCQ CalMacCQ commented Sep 9, 2024

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 the conf.py in this repository.

Screenshot 2024-09-09 at 18 58 46

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog with any user-facing changes

@CalMacCQ CalMacCQ marked this pull request as draft September 9, 2024 17:59
@CalMacCQ CalMacCQ changed the title docs: Use shared pytket docs config [DEMO] docs: Use shared pytket docs config [DRAFT] Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants