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.

Sign up for GitHub

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

Jump to bottom

Add mechanism to group API ToC into sections #1256

Merged
merged 8 commits into from
Apr 30, 2024
Merged

Add mechanism to group API ToC into sections #1256

merged 8 commits into from
Apr 30, 2024

Conversation

Eric-Arellano
Copy link
Collaborator

Prework for #1255. This PR only adds the generic mechanism but doesn't yet use it for Qiskit to keep the diff smaller.

frankharkins
frankharkins reviewed Apr 30, 2024
View reviewed changes
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.

Thanks for splitting this into more than one PR

scripts/lib/api/generateToc.ts Show resolved Hide resolved
scripts/lib/api/generateToc.ts Outdated Show resolved Hide resolved
scripts/lib/api/TocGrouping.ts Outdated Show resolved Hide resolved
scripts/lib/api/TocGrouping.ts Outdated Show resolved Hide resolved
scripts/lib/api/generateToc.ts Show resolved Hide resolved
@Eric-Arellano Eric-Arellano mentioned this pull request Apr 30, 2024
Merged
frankharkins
frankharkins approved these changes Apr 30, 2024
View reviewed changes
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.

Thanks!

github-merge-queue bot pushed a commit that referenced this pull request Apr 30, 2024
@Eric-Arellano
Refactor generateToc.ts to not use dictionary type (#1259)
d9330b3 
Prework for #1256. It was
confusing how we pass both `tocModules: TocEntry[]` and
`tocModulesByTitle: Dictionary<TocEntry>`. It wasn't clear how those
values relate, and `Dictionary` is an under-documented API by Lodash.

Also adds `hasPrefix`, which we will need in
#1256.
@Eric-Arellano Eric-Arellano added this pull request to the merge queue Apr 30, 2024
Merged via the queue into main with commit 6497188 Apr 30, 2024
2 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/allow-grouping branch April 30, 2024 21:04
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
@Eric-Arellano
Refactor generateToc.ts to not use dictionary type (Qiskit#1259)
c1c3280 
Prework for Qiskit#1256. It was
confusing how we pass both `tocModules: TocEntry[]` and
`tocModulesByTitle: Dictionary<TocEntry>`. It wasn't clear how those
values relate, and `Dictionary` is an under-documented API by Lodash.

Also adds `hasPrefix`, which we will need in
Qiskit#1256.
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
@Eric-Arellano
Add mechanism to group API ToC into sections (Qiskit#1256)
e719d6e 
Prework for Qiskit#1255. This PR
only adds the generic mechanism but doesn't yet use it for Qiskit to
keep the diff smaller.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frankharkins frankharkins frankharkins approved these changes

@arnaucasau arnaucasau Awaiting requested review from arnaucasau

Assignees
No one assigned
Labels
None yet
Projects
Docs Planning
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Eric-Arellano @frankharkins