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

Exceptions are missing headers in API docs #712

Closed
Tracked by #479
Eric-Arellano opened this issue Jan 25, 2024 · 0 comments · Fixed by #713
Closed
Tracked by #479

Exceptions are missing headers in API docs #712

Eric-Arellano opened this issue Jan 25, 2024 · 0 comments · Fixed by #713
Assignees
@frankharkins
Labels
API docs infra 🏗️
Milestone
24-02-15 Qiskit 1.0

Comments

@Eric-Arellano
Copy link
Collaborator

See https://docs.quantum.ibm.com/api/qiskit/exceptions. It would be useful for the exceptions to have headers so that:

  1. They show up in the right sidebar
  2. They are more visually distinct
  3. You can get an anchor link for them

This will look very similar to #683. I suspect we also want to use ### (h3) for now.

Screenshot 2024-01-25 at 5 02 57 PM Screenshot 2024-01-25 at 5 03 13 PM
@Eric-Arellano Eric-Arellano added this to the 24-02-13 Qiskit 1.0 milestone Jan 25, 2024
@frankharkins frankharkins self-assigned this Jan 26, 2024
@frankharkins frankharkins mentioned this issue Jan 26, 2024
Merged
@Eric-Arellano Eric-Arellano moved this to In Review in Docs Planning Jan 26, 2024
github-merge-queue bot pushed a commit that referenced this issue Jan 26, 2024
@frankharkins
Add headers for exceptions (#713)
4381020 
Quick fix to use the same logic for functions and exceptions. Closes
#712.

A known problem with this implementation is that some headings should
not be `h3`, but it depends on the page. See
#714.
@github-project-automation github-project-automation bot moved this from In Review to Done in Docs Planning Jan 26, 2024
@Eric-Arellano Eric-Arellano mentioned this issue Jan 31, 2024
Closed
frankharkins added a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@frankharkins
Add headers for exceptions (Qiskit#713)
00d539f 
Quick fix to use the same logic for functions and exceptions. Closes
Qiskit#712.

A known problem with this implementation is that some headings should
not be `h3`, but it depends on the page. See
Qiskit#714.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@frankharkins frankharkins

Labels
API docs infra 🏗️
Projects
Docs Planning
Archived in project
Milestone
24-02-15 Qiskit 1.0
Development

Successfully merging a pull request may close this issue.

Add headers for exceptions Qiskit/documentation
2 participants
@Eric-Arellano @frankharkins