-
Notifications
You must be signed in to change notification settings - Fork 47
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
Properly support global variables in API docs (.. py:data::
)
#1401
Comments
github-merge-queue bot
pushed a commit
that referenced
this issue
May 17, 2024
We will set up redirects in closed source. The new circuit module rewrite suffers from #1401. That's not blocking this release, though.
Oh boy - "A |
Eric-Arellano
changed the title
Properly support
Properly support global variables in API docs (May 17, 2024
.. py:data::
.. py:data::
)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This builds on top of #935, which is about broken cross-references. This issue is to also have a more intentional visual design for
.. py:data::
, such as an MDX component like<GlobalVariable>
(name tbd).unannotated screenshot
annotated screenshot
offending code
documentation/docs/api/qiskit/dev/circuit.mdx
Lines 883 to 893 in 394ca77
I propose the design should look the same as our other components: a purple or blue left bar, header inside the component (#1395) with whatever the correct surrounding level would be, and ensure there is a
<span id>
or that the header has the ID.The text was updated successfully, but these errors were encountered: