Refactor scripts, generate reference documentation - #59
Open
elegios wants to merge 1 commit into
Open
Conversation
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.
This PR adds a very basic script for extracting all definitions and their documentation from the TreePPL standard library. The script is AI-generated, but appears to work correctly, and the result can be checked before publication, so it seems good enough for now.
Down the road we'd like to use the documentation generator written for Miking, but adapted to TreePPL, but it isn't quite ready yet, and we at least need something basic for now.
Suggest bullets to add to the changelog below (under
###headings), if any. A PR that has a user-visible change should have a bullet, even if it's, e.g., just a bugfix.TreePPL Release Notes
Added
Changed
Deprecated
Removed
Fixed
Security