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

Group Qiskit table of contents into sections #1255

Merged
merged 29 commits into from
May 7, 2024
Merged

Conversation

Eric-Arellano
Copy link
Collaborator

@Eric-Arellano Eric-Arellano commented Apr 29, 2024

Closes #1211. See Qiskit/qiskit#12333 for the sibling PR in Qiskit. We'll land the test #1300 once both PRs have landed.

This uses the same grouping as #1211 (comment), if people prefer reviewing the list over code.

Before:
Screenshot 2024-05-01 at 10 27 43 AM

After:

Screenshot 2024-05-01 at 10 28 02 AM Screenshot 2024-05-01 at 10 28 15 AM

This also improves historical APIs

Screenshot 2024-05-01 at 10 29 08 AM

github-merge-queue bot pushed a commit that referenced this pull request Apr 30, 2024
Prework for #1255. This PR
only adds the generic mechanism but doesn't yet use it for Qiskit to
keep the diff smaller.
@Eric-Arellano Eric-Arellano force-pushed the EA/qiskit-leftnavbar branch 2 times, most recently from 628595e to a1771a3 Compare May 1, 2024 14:25
@Eric-Arellano Eric-Arellano changed the title [wip] Group Qiskit table of contents into sections Group Qiskit table of contents into sections May 1, 2024
Copy link
Member

@frankharkins frankharkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

@Eric-Arellano Eric-Arellano enabled auto-merge May 7, 2024 12:47
@Eric-Arellano Eric-Arellano added this pull request to the merge queue May 7, 2024
Merged via the queue into main with commit 6ca32f3 May 7, 2024
5 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/qiskit-leftnavbar branch May 7, 2024 12:49
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Prework for Qiskit#1255. This PR
only adds the generic mechanism but doesn't yet use it for Qiskit to
keep the diff smaller.
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
Closes Qiskit#1211. See
Qiskit/qiskit#12333 for the sibling PR in
Qiskit. We'll land the test
Qiskit#1300 once both PRs have
landed.

This uses the same grouping as
Qiskit#1211 (comment),
if people prefer reviewing the list over code.

Before:
<img width="254" alt="Screenshot 2024-05-01 at 10 27 43 AM"
src="https://github.com/Qiskit/documentation/assets/14852634/5b503347-accd-4847-a7e2-aedf3546fcba">

After:

<img width="269" alt="Screenshot 2024-05-01 at 10 28 02 AM"
src="https://github.com/Qiskit/documentation/assets/14852634/c1a358f6-26f5-4e6e-80e9-2ee440eec94f">

<img width="272" alt="Screenshot 2024-05-01 at 10 28 15 AM"
src="https://github.com/Qiskit/documentation/assets/14852634/c3c80ca7-96e5-4942-ac39-6795b9504277">

This also improves historical APIs

<img width="271" alt="Screenshot 2024-05-01 at 10 29 08 AM"
src="https://github.com/Qiskit/documentation/assets/14852634/362cc70f-4c7e-49c4-9447-78af2a648452">
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.

Qiskit API: group modules into logical sections
2 participants