Scripts for generating interactive spec docs #630
Merged
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.
Adds scripts to generate flattened, interactive, html documentation.
Scripts will traverse the python typing hierarchy and produce nested tables with yaml examples at every level of the hierarchy. This gives us maximum flexibility both for rendering as well as for interacting with the documentaiton.
The logic can then be further expanded to add more metadata, like documentation for GUIs, that can be picked up by other external tools