[Feature] Add pydoc-markdown foundation for Python API docs#1381
Open
viiccwen wants to merge 1 commit into
Open
[Feature] Add pydoc-markdown foundation for Python API docs#1381viiccwen wants to merge 1 commit into
viiccwen wants to merge 1 commit into
Conversation
viiccwen
requested review from
400Ping,
guan404ming and
ryankert01
as code owners
Contributor
Author
|
cc @400Ping 🙌 |
ryankert01
reviewed
Jun 7, 2026
| - qumat_qdp.triton_amd | ||
|
|
||
| # TODO: Trim this filter once the Python package exposes a cleaner public | ||
| # surface for documentation generation. |
Member
There was a problem hiding this comment.
What is a cleaner public surface. Mind open an issue tracking this?
Contributor
Author
There was a problem hiding this comment.
Sure, that makes sense. What I had in mind was making the QDP Python API boundary explicit, maybe through package-level exports / __all__ or a small docs manifest. Then the docs generator wouldn’t need to enumerate implementation modules and filter out imported helpers.
Agree it should be tracked separately. I’ll open a follow-up issue for the API surface.
viiccwen
changed the title
9 tasks
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
2 participants
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 #1346
Changes
Why
Mahout's Python API reference should be generated from source so contributors have a reproducible foundation for API documentation work.
How
Adds an initial pydoc-markdown-based Python API documentation foundation:
docs/api/qumatandqumat_qdpChecklist