Orgainization | [The Perl foundation] | |
Project name | Redesign of the Perl 6 Documentation System | |
Primary repository | Perl6-Documentable | |
Project Mentors | Juan J. Merelo, Richard Hainsworth, Patric Speck, Tom Browder | |
Project Page | Summer of Code Project Page | |
Status | Completed |
Remake part of the tooling used to generate documentation in Perl 6. The main aim of this project is provide an easy-to-use tool generate static files containing the documentation and provide and high-level API to consult it.
Note: this is a briefly report, to see the work done thoroughly, please check the READMEs files and the documentations.
I have worked in three different repositories:
- Pod::Utilities
- Perl6::TypeGraph
- Perl6::Documentable. You can check the documentation here.
- Docker container: easy way to get everything working.
I have also made some contributions to the main perl6/doc repository, you can check them here.
- GSoC 2019 serie. They are all packed in a "series" of dev.to articles.
I have not been able to integrate Pod::Render in my project. We need to investigate why it is so slow before achieve that). It has a good suite of tests and it lets the user to override a fair amount of templates to customize the result.