I’m happy to announce that
dhall-docs has been released!
The tool is still on the development phase, there are things that probably will change but it’s somewhat useful to actually start generating some documentation.
The features of the tool are:
- Header documentation extracting;
- Examples from assertions;
- Rendered source code;
- Navigatable breadcrumbs;
- Dark & Light mode
On the project README you can check how to use it: https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-docs
Here you can see a demo of the generated documentation for the Dhall Prelude: https://hydra.dhall-lang.org/build/64022/download/1/docs/
The package has been released on hackage: https://hackage.haskell.org/package/dhall-docs
I’ve been blogging about the development process. This is the first post: https://dev.to/german1608/gsoc-2020-dhall-documentation-generator-37l. There you can see the index for the other ones
Please comment in this thread with any suggestions or improvements that you think might help
dhall-docs get better.