Skip to content
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

Regenerate qiskit API docs #1102

Closed
wants to merge 26 commits into from
Closed

Conversation

arnaucasau
Copy link
Collaborator

Part of #1008

This PR regenerates qiskit API with the design changes introduced in #1026

@arnaucasau arnaucasau changed the title [WIP] Regenerate qiskit API docs Regenerate qiskit API docs Mar 27, 2024
@arnaucasau arnaucasau marked this pull request as ready for review March 27, 2024 16:50
@qiskit-bot
Copy link
Contributor

Thanks for contributing to Qiskit documentation!

Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌

github-merge-queue bot pushed a commit that referenced this pull request Mar 27, 2024
This small PR changes the regex used in the link checker to parse the
anchors for a non-greedy version of it. After regenerating the API docs
with the mdx components, our link checker wasn't able to detect the id
from them that we previously had as `<span>` tags.

The problem was how the script was searching for the ids. In the the
following screenshots, we can see the change introduced here.

**Before**

![Captura desde 2024-03-27
17-27-06](https://github.com/Qiskit/documentation/assets/47946624/d1896d55-2a94-4992-8ec3-c52234aefd6a)

**After**
![Captura desde 2024-03-27
17-39-51](https://github.com/Qiskit/documentation/assets/47946624/0b063a3e-9ef6-4d5f-a775-cf53497339ec)

More information on the non-greedy quantifier here:
https://www.ibm.com/docs/en/netcoolomnibus/8.1?topic=library-minimal-non-greedy-quantifiers

To see that it fixed the issue, this change was applied to ##1094,
#1101, and #1102
@arnaucasau arnaucasau marked this pull request as draft March 28, 2024 17:36
@arnaucasau arnaucasau closed this Apr 3, 2024
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
…1104)

This small PR changes the regex used in the link checker to parse the
anchors for a non-greedy version of it. After regenerating the API docs
with the mdx components, our link checker wasn't able to detect the id
from them that we previously had as `<span>` tags.

The problem was how the script was searching for the ids. In the the
following screenshots, we can see the change introduced here.

**Before**

![Captura desde 2024-03-27
17-27-06](https://github.com/Qiskit/documentation/assets/47946624/d1896d55-2a94-4992-8ec3-c52234aefd6a)

**After**
![Captura desde 2024-03-27
17-39-51](https://github.com/Qiskit/documentation/assets/47946624/0b063a3e-9ef6-4d5f-a775-cf53497339ec)

More information on the non-greedy quantifier here:
https://www.ibm.com/docs/en/netcoolomnibus/8.1?topic=library-minimal-non-greedy-quantifiers

To see that it fixed the issue, this change was applied to #Qiskit#1094,
Qiskit#1101, and Qiskit#1102
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants