python-wheels: support automatic documentation updates#169
Draft
threexc wants to merge 5 commits into
Draft
Conversation
Add a new version ofthe update_doc.py script from wheel_builder, converted using Claude. Compared to the old one, we just generate, parse, and update Markdown files directly for each package, and do it in docs/packages/<package>.md instead of the longer docs/source/packages/<package>.yaml. AI-Generated: Uses Claude Code Sonnet 5 Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
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.
DO NOT REVIEW/MERGE - WIP
In wheel_builder, we used to have automatic documentation updates when support for new package versions was merged to main. This was pointed out in #159 and re-enabling it was identified as a priority following the dev guide's acceptance. For this repository, we have to make some adjustments to our approach, including a rework of the old
update_doc.pyscript. This also lends itself to the composite action idea for publishing we also discussed in #159, so add that now.Things get a little simpler now, since we're directly generating and modifying Markdown files. The new
publish-wheelaction (name likely changing topub-wheels-gen-docs) is complex enough that it needs careful documentation, so make sure to describe its purpose fully in the dev guide, by updating the example usingbuild-numpy.yml.