Improve function handling #683
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
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
frankharkins
force-pushed
the
FH/api-functions
branch
from
0451642 to
99ccc68
Compare
scripts/lib/api/processHtml.test.ts
Outdated
| doc.expectHtml(`<strong>Example</strong> | ||
| <strong>Examples</strong> | ||
| <strong>References</strong> | ||
| <h2>Reference</h2> |
There was a problem hiding this comment.
This should be <strong> because it's "member-specific", similar to an example. Rather than signifying the start of a new section with its own "code members", this is only added info about the current member.
|
All Qiskit versions have been regenerated so this can be merged when you both think it's ready 👍. Thank you so much @frankharkins for waiting! |
|
You'll need to regenerate the Qiskit 0.45 docs. You can run this: |
Eric-Arellano
approved these changes
Jan 25, 2024
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 25, 2024
- Restore `_package.json` that was accidentally deleted in #683
This was referenced Jan 25, 2024
This was referenced Feb 2, 2024
frankharkins
added a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
This PR improves how the API generation script handles functions. ## Changes ### Demote some `h2` tags to `strong` We currently convert all `.rubric` elements to `h2`, but this makes some headings higher-level than they should be (specifically "Example" and "References" headings). For an example see [api/qiskit/converters](https://docs.quantum.ibm.com/api/qiskit/converters). <img width="197" alt="Screenshot 2024-01-23 at 17 37 33" src="https://github.com/Qiskit/documentation/assets/36071638/618a256b-9bdf-481b-bb49-e3eea7476b8e"> This PR converts rubrics to `strong` (rather than `h2`) if the name is "Example(s)" or "Reference(s)". This is a bit hacky, but it seems to work and I can't think of a better way of doing it. The Sphinx LaTeX writer also takes a [similar approach](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-rubric). I've regenerated the docs using this new logic and I can see no false positives (that is, cases in which we use `strong` where we should use `h2`). ### Add function names as headings Functions currently have no headings. This PR adds a `h3` with the function name, which improves readability, gives anchor tag icons, and will add more functions to the right sidebar. I've also included some logic to avoid adding function names when the page is already dedicated to the function (such as [least_busy](https://docs.quantum.ibm.com/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy)). One quirk with this I spotted was some function names not appearing in the sidebar in `/api/qiskit/utils` (see `add_deprecation_to_docstring` in the screenshot). This is possibly because the title hierarchy skips `h2`.  *** Closes Qiskit#231 --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
frankharkins
added a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
- Restore `_package.json` that was accidentally deleted in Qiskit#683
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.
This PR improves how the API generation script handles functions.
Changes
Demote some
h2tags tostrongWe currently convert all
.rubricelements toh2, but this makes some headings higher-level than they should be (specifically "Example" and "References" headings). For an example see api/qiskit/converters.This PR converts rubrics to
strong(rather thanh2) if the name is "Example(s)" or "Reference(s)". This is a bit hacky, but it seems to work and I can't think of a better way of doing it. The Sphinx LaTeX writer also takes a similar approach.I've regenerated the docs using this new logic and I can see no false positives (that is, cases in which we use
strongwhere we should useh2).Add function names as headings
Functions currently have no headings. This PR adds a
h3with the function name, which improves readability, gives anchor tag icons, and will add more functions to the right sidebar.I've also included some logic to avoid adding function names when the page is already dedicated to the function (such as least_busy).
One quirk with this I spotted was some function names not appearing in the sidebar in
/api/qiskit/utils(seeadd_deprecation_to_docstringin the screenshot). This is possibly because the title hierarchy skipsh2.Closes #231