Handle Sphinx data type #1917
Merged
Handle Sphinx data type #1917
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
This was referenced Sep 6, 2024
github-merge-queue bot
pushed a commit
that referenced
this pull request
Sep 6, 2024
Follow up to #1917. That resulted in some pages having their behavior fixed, so we can be more strict in our API lints. This PR also makes some bigger improvements to the checks: * Runs `check:metadata` in CI, thanks to a new allowlist * Simplifies `check:orphan-pages` to have an `--apis` arg * DRYs our ignore list for `check:internal-links`
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.
Closes #1401 and #935.
We reuse
<Attribute>, which actually works out quite well! It understands how to parse when the data object has a value assigned to it like= "my_value". It can also properly detectisDedicatedPage.There is one weird edge case: Qiskit was improperly using
.. py:data::inside a table inutils.mdx. Naively, it would cause issues with trying to render the component inside the table, which does not work. I fixed it in Qiskitmain, but it would be too time consuming to fix on 0.35+. So, we now have a line to skip over converting to anAttributeComponent if the element is inside a table. That means the table will continue to render the same as before on those historical docs - the biggest downside is that anchor links still will be broken for the page.A follow up will simplify our linters like checking for orphan pages, since this PR fixes a lot of those problems.