Skip to content

Conversation

@ZivoMartin
Copy link

Summary

This PR adds generated documentation for each file contained in the stdlib.

Since docgen requires a file as entry point, I created a file that includes all files in the stdlib, and the documentation is generated from this entry file.

Implementation Details

  • The Miking stdlib is very large (~150,000 lines of code).
  • Running the Miking parser on it in keep dead code mode is not feasible on a regular laptop.
  • To address this, I wrote a Python script that generates the documentation step by step.

Next Steps

The script currently requires some understanding of how docgen works in order to generate the stdlib documentation.
I plan to improve the script so that the process can be automated and simplified, ideally requiring only a single activation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant