docs: fixes to docs build checks and links #443
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CalMacCQ
commented
Dec 31, 2024
| @@ -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) | |||
There was a problem hiding this comment.
This is needed as there is a RemoveBarriers class in qiskit as well so sphinx complains that the target is not unique. Adding the _tket seems to fix this. This prefix is replaced by the build script so no _tket links appear in the built pages
CalMacCQ
changed the title
_tket links in built html_tket links in built html
CalMacCQ
changed the title
_tket links in built html
|
@cqc-melf do you know why this command is failing? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
I discovered that the docs build was failing silently in C.I. as we did not use the
-eflags to propogate the error and make the C.I. fail.Also due to the update to the API docs made in CQCL/tket#1721 the links which sphinx resolves to
_tket.passesdon't work properly.The solution I've found is very similar to CQCL/tket#1721 in that I just add some commands to the build script to replace all of the
_tketprefixes in the built html.Note that this PR just fixes the links in the local build. The website has been fixed in a different PR which should handle the other extensions too.
Related issues
CQCL/tket#1719
closes #444
Checklist