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: fix link for RemoveBarriers pass, update docs build scripts #457

Merged
merged 4 commits into from
Feb 3, 2025

Conversation

CalMacCQ
Copy link
Contributor

@CalMacCQ CalMacCQ commented Feb 3, 2025

Description

  1. Picking up the docs link fix from docs: fixes to docs build checks and links #443 so we don't have to wait for the docs build in C.I. to be fixed.
  2. Update docs theming submodule
  3. update the docs build script to replace all _tket links for the passes in the default compilation table

Only (1.) affects the website. Everything else is just for the docs build in pytket-qiskit. This is still broken. See #458

Drive by: black format the qiskit_convert.py file after a black package update.

closes #444

@CalMacCQ CalMacCQ requested a review from cqc-melf as a code owner February 3, 2025 16:08
@CalMacCQ CalMacCQ changed the title docs: fix link for RemoveBarriers pass docs: fix link for RemoveBarriers pass, update docs build scripts Feb 3, 2025
@@ -15,6 +15,14 @@ sed -i '' 's#CQCL/tket#CQCL/'$EXTENSION_NAME'#' _static/nav-config.js
# Build the docs. Ensure we have the correct project title.
sphinx-build -b html -D html_title="$EXTENSION_NAME" . build

if [[ "$OSTYPE" == "darwin"* ]]; then
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is to replace all the _tket links in the (LOCAL) docs build

@@ -208,7 +208,7 @@ Every {py:class}`~pytket.backends.backend.Backend` in pytket has its own {py:met
* - [AutoRebase [2]](inv:#*.AutoRebase)
- [SynthesiseTket](inv:#*.SynthesiseTket)
- [FullPeepholeOptimise](inv:#*.passes.FullPeepholeOptimise)
- [RemoveBarriers](inv:#*pytket.passes.RemoveBarriers)
- [RemoveBarriers](inv:#*pytket._tket.passes.RemoveBarriers)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems weird but I've verified that this works in the built html. The _tket line is replaced so there is no danger of broken links.

@CalMacCQ CalMacCQ requested review from cqc-alec and removed request for cqc-melf February 3, 2025 16:51
@CalMacCQ CalMacCQ merged commit 662fcfa into main Feb 3, 2025
5 checks passed
@CalMacCQ CalMacCQ deleted the CalMacCQ-patch-1 branch February 3, 2025 17:08
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.

Flaky links in pytket-qiskit docs index page
2 participants