Skip to content

test the qiskit-noise-learning subsite - #5603

Merged
Kaelyn Ferris (kaelynj) merged 15 commits into
mainfrom
ajc/test-qiskit-nl
Sep 11, 2026
Merged

test the qiskit-noise-learning subsite#5603
Kaelyn Ferris (kaelynj) merged 15 commits into
mainfrom
ajc/test-qiskit-nl

Conversation

@abbycross

Copy link
Copy Markdown
Collaborator

A test to understand how the pipeline works in preparation to migrating API docs/guides

@abbycross

abbycross commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator Author

cc: Kaelyn Ferris (@kaelynj) Some things to resolve:

  • How to make the citations render properly (see formalism/index for examples)
  • How to make toc render properly (what do we need in the source repo for this to happen? Do we need a guides/ dir and some other expected files, like index.rst and install.rst for the toc to generate properly?)
  • right now we don't even see the API docs in my local preview left nav (using --apis), though those files have imported, and I can get to them with a direct URL
  • I don't see a package file and so am using 0.1.0 as a version placeholder. I assume this is also why the release notes are broken
  • Check all the broken links in the CI link checker - is this a pipeline problem?

@abbycross

Copy link
Copy Markdown
Collaborator Author

Eric Harvey (@eharvey328) Kaelyn Ferris (@kaelynj) I don't know why this would affect generation of the toc, but is part of the problem that some of the docs are markdown files? I see that the other packages use only rst and ipynb. Worth converting all the md to one of those?

…ddon guide links

- Preserve anchor IDs on `math-wrapper` divs so numbered Sphinx
  equations keep working links (previously only `section` divs kept
  their `id`).
- Kebab-case only the final path segment when rewriting links to
  nested generated pages, so folder separators aren't collapsed.
- Rewrite relative `guides/...` links in addon API reference pages to
  absolute paths under `docs/addons/<pkg>/guides/`.

@eharvey328 Eric Harvey (eharvey328) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM! Thank you

@kaelynj
Kaelyn Ferris (kaelynj) added this pull request to the merge queue Sep 11, 2026
Merged via the queue into main with commit 8ab2896 Sep 11, 2026
5 checks passed
@kaelynj
Kaelyn Ferris (kaelynj) deleted the ajc/test-qiskit-nl branch September 11, 2026 19:15
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