Automatically generate API documentation from PyScript source.#201
Open
Automatically generate API documentation from PyScript source.#201
Conversation
…omewhere the docs can find it.
…can be generated.
16 tasks
…h submodule. All to be autogenerated from the source files in ./pyscript.
Contributor
|
I went through these changes and I would approve if this wasn't still a WIP |
Member
Author
|
Apologies... ready for review. 👍 |
WebReflection
approved these changes
Dec 12, 2025
Contributor
WebReflection
left a comment
WebReflection
left a comment
There was a problem hiding this comment.
Not sure it needs to be re-generated but looks good to me.
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.
This PR introduces a few changes to allow the API docs to be automatically generated from the referenced release of PyScript.
api.mdfile to reference the Python module structure.version-update.jsby adding synchronous downloading of the referenced PyScript release, extraction of thepyscriptnamesapce, and clean-up of the zip.pyscriptdirectory populated with the proposedpyscriptnamespace (a work in progress here:pyscriptAPI/docstring refactor with comprehensive tests pyscript#2414)This is a draft PR since further work is likely to be stacked on top of it (we don't want to merge until all the work is complete, otherwise the current website is automatically updated).