docs: improve Python API reference UX - #1457
Open
viiccwen wants to merge 1 commit into
Open
Conversation
Signed-off-by: viiccwen <vicwen@apache.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
Closes #1357
Related to #1361
Changes
Why
The generated Python API references were published separately from the existing Qumat and QDP API documentation.
This resulted in duplicate API entries and made it unclear which reference users should open. The generated pages also used product-specific Python API titles even though their surrounding Qumat and QDP sections already provide that context.
The current documentation additionally contained stale
/docs/next/links and an outdated Qumat getting-started example.How
qumat/api.qdp/api.API Referenceconsistently as the page title, heading, and sidebar label.This PR does not include QDP source-docstring formatting changes; those are handled separately under #1358.
Validation
npm run typechecknpm run build/docs/master/qumat/api/docs/master/qdp/api/docs/master/apilanding route is no longer generated.API Referencefor their title, heading, and sidebar label.qdp/qdp-python/qumat_qdp.The website build succeeds with existing broken-link warnings from the unchanged 0.4 and 0.6 documentation snapshots.
Checklist