[Feature] Generate Python API docs from module discovery#1392
Open
viiccwen wants to merge 1 commit into
Open
Conversation
viiccwen
requested review from
400Ping,
guan404ming and
ryankert01
as code owners
viiccwen
changed the title
viiccwen
changed the title
Contributor
Author
|
It's normal that website build failed before #1381 got merged (already tested correctly in local environment). |
Contributor
Author
|
cc @400Ping 🙌 |
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
1 participant
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 #1347
previous PR #1381 (merge first)
Changes
Why
The Python API reference should be generated from the agreed public module surface instead of maintaining pydoc-markdown module lists by hand. Manual lists can drift from the current
qumatandqumat_qdpsource tree, while a deterministic generation path makes the website API docs easier to refresh and review as the Python packages evolve.This keeps
/docs/apias the source for API documentation generation settings and metadata, while publishing the rendered API pages through the Docusaurus website docs tree.How
docs/apigenerator config directly and instead renders API pages intowebsite/docs/api.website/scripts/sync-docs.js, including thequmatandqumat_qdppydoc-markdown configs.website/docsso the generated API pages are included with the synced website docs.qumatandqumat_qdppages.CONTRIBUTING.md.Screenshot
Checklist