fix: broken crosslinks to user guide #1571
Merged
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
cqc-alec
requested changes
Sep 11, 2024
pytket/docs/backends.rst
Outdated
| @@ -3,11 +3,11 @@ pytket.backends | |||
|
|
|||
| Contains :py:class:`Backend` abstract class and associated methods. In pytket a :py:class:`Backend` represents an interface between pytket and a quantum device or simulator. Different backends are defined in the various pytket extension modules and inherit from the core pytket :py:class:`Backend` class. | |||
|
|
|||
| There are several `example notebooks <https://tket.quantinuum.com/examples>`_ on pytket :py:class:`Backend`\s. If you are interested in developing your own :py:class:`Backend` or pytket extension then see the `creating backends <https://tket.quantinuum.com/examples/creating_backends.html>`_ tutorial. | |||
| There are several `example notebooks <https://tket.quantinuum.com/examples>`_ on pytket :py:class:`Backend`\s. If you are interested in developing your own :py:class:`Backend` or pytket extension then see the `creating backends <https://tket.quantinuum.com/user-guide/examples/creating_backends.html>`_ tutorial. | |||
There was a problem hiding this comment.
I get 404 with this URL.
There was a problem hiding this comment.
Thanks for spotting... fixed in e197d77
Co-authored-by: Alec Edgington <[email protected]>
cqc-alec
approved these changes
Sep 12, 2024
CalMacCQ
added a commit
that referenced
this pull request
Sep 13, 2024
* fix: broken crosslinks to user guide * Update README.md Co-authored-by: Alec Edgington <[email protected]> * fix creating backends link --------- Co-authored-by: Alec Edgington <[email protected]>
5 tasks
CalMacCQ
added a commit
that referenced
this pull request
Sep 13, 2024
* fix: broken crosslinks to user guide (#1571) * fix: broken crosslinks to user guide * Update README.md Co-authored-by: Alec Edgington <[email protected]> * fix creating backends link --------- Co-authored-by: Alec Edgington <[email protected]> * docs: use latest version of theming submodule (#1574) * bump submodule * Revert "bump submodule" This reverts commit 063de1d. --------- Co-authored-by: Alec Edgington <[email protected]>
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
Fixed some broken links to the user guide. These were caused by the changes in CQCL/pytket-docs#339
Not so happy with this fix as I'm still using the full URL links
It should be possible to link to subsections of the docs using intersphinx and sphinx-autosectionlabel but I couldn't quite get it to work yet. This would mean that the full URL would only be written in the
conf.pyand it would be easy to get more robust linking. In the event of a URL change we could only update the link in a single place.The autoforwarding from the old links also doesn't seem to be working properly so at least this PR addresses the link breakage for now.
Related issues
Please mention any github issues addressed by this PR.
Checklist