Frontend/Backend docs clean up #2124
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
the `doc` role is more suited for the purposes here of linking to pages. If one wishes to link to a specific section, the `ref` role would be the way to go. Here we were mostly only using `ref` superficially to link to headers. If that's the case linking to the document itself makes most sense.
this ensures proper format when using `jupytext` to convert between markdown and notebook formats (e.g. ipynb)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2124 +/- ##
=======================================
Coverage 98.21% 98.21%
=======================================
Files 87 87
Lines 4150 4150
=======================================
Hits 4076 4076
Misses 74 74 ☔ View full report in Codecov by Sentry. |
andreamari
approved these changes
Dec 14, 2023
Comment on lines
+16
to
+17
| In short, a frontend is the tool used to write a quantum program, and a backend is the tool that executes said program. | ||
| What follows is more detailed information as to how these concepts are handled in Mitiq. |
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| jupytext: | |||
| text_representation: | |||
| extension: .myst | |||
| extension: .md | |||
There was a problem hiding this comment.
Thanks for fixing all the extensions. Now files are correctly opened by Jupyter Notebook + jupytext.
| @@ -70,7 +69,7 @@ the expectation value to mitigate. This function will: | |||
| 2. Run the circuit. | |||
| 3. Convert from raw measurement statistics (or a different output format) to an expectation value. | |||
|
|
|||
| For information on how to define more advanced executors, see the {ref}`Executors <guide/executors/executors>` section of the Mitiq user guide. | |||
| For information on how to define more advanced executors, see the {doc}`../guide/executors` section of the Mitiq user guide. | |||
There was a problem hiding this comment.
What is the main difference between {ref} and {doc} ?
There was a problem hiding this comment.
Great question! I had to figure that out too.
- The
{ref}role is an all-purpose link-creating-tool for creating references to documents and labeled sections of documents (e.g. an anchor within a specific page). - The
{doc}role is specifically made for referencing local documents only (no external documents, and no anchors/sections/equations/images/etc). One thing to note here with{doc}, is that if we do not pass text in for the link, it uses the title of the page we are linking to. - It's worth mentioning that both of these can be achieved with markdown links
[text](link)as well, so why bother with either of these roles? When using{ref}and{doc}, we are providing sphinx with more information than it would get otherwise, and is able to some magic and make our lives easier. I'm not totally clear on what, but I think it makes refactoring easier as sphinx will know that specific references are broken using this syntax.
As for why sphinx has both {doc} and {ref}, I'm not sure. It does seem a bit redundant to me. Why not just have the more powerful one? That said, I always like the idea of using the simplest solution to a problem, and that includes using the simplest available tool.
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
This PR started with the intention of clarifying some language about frontend/backend compatibility as per #1313, but I found the language to be quite clear. So I used this as an opportunity to clean up some of the code, as well as to ensure all our docs work well with
jupytextby correctly setting theextensionin the jupytext metadata.fixes #1313