Adding a Stdlib module in docs containing the full stdlib documentation #36
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.
Summary
This PR adds generated documentation for each file contained in the
stdlib.Since
docgenrequires a file as entry point, I created a file that includes all files in thestdlib, and the documentation is generated from this entry file.Implementation Details
stdlibis very large (~150,000 lines of code).Next Steps
The script currently requires some understanding of how
docgenworks in order to generate thestdlibdocumentation.I plan to improve the script so that the process can be automated and simplified, ideally requiring only a single activation.