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 invalid table in docs #547

Merged
merged 1 commit into from
Nov 22, 2024
Merged

docs: fix invalid table in docs #547

merged 1 commit into from
Nov 22, 2024

Conversation

CalMacCQ
Copy link
Contributor

@CalMacCQ CalMacCQ commented Nov 21, 2024

Description

Minor fix. After #546 the table had an invalid number of columns and the RemoveBarriers pass didn't show up. Should be fixed now.

Fixed the pytket-qiskit one in CQCL/pytket-qiskit#421

@CalMacCQ CalMacCQ requested a review from yao-cqc as a code owner November 21, 2024 17:21
@CalMacCQ CalMacCQ requested a review from sjdilkes November 21, 2024 17:21
@@ -104,7 +104,7 @@ the circuit 2-qubit gate count is not reduced after compilation.
* - [AutoRebase [2]](inv:#*.AutoRebase)
- [SynthesiseTket](inv:#*.SynthesiseTket)
- [FullPeepholeOptimise [3]](inv:#*.passes.FullPeepholeOptimise)
- [RemoveBarriers](inv:#*.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.

Not sure why this first reference didn't resolve. Tested that this replacement works locally though.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't know why it wouldn't work. Does this now show the name _tket in the docs? I think we want to avoid that.

Copy link
Contributor Author

@CalMacCQ CalMacCQ Nov 22, 2024

Choose a reason for hiding this comment

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

Yeah unfortunately I'll need to fix that in the TKET API docs. There's a replacement of all of the _tket names that isn't working currently. However I would've thought this resolver used module imports and that the module names on the webpage wouldn't matter.

EDIT: external links are done with intersphinx. See the intersphinx_mapping in docs/pytket-docs-theming/conf.py so the docs page does actually matter.

@CalMacCQ CalMacCQ requested review from cqc-alec and removed request for sjdilkes and yao-cqc November 22, 2024 10:48
@CalMacCQ CalMacCQ merged commit 49ccaf6 into main Nov 22, 2024
12 of 13 checks passed
@CalMacCQ CalMacCQ deleted the docs/fix_table branch November 22, 2024 11:35
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