Documentation generator for the Dhall configuration language
- Mentors
- Profpatsch, Gabriel Gonzalez, sjakobi
- Organization
- Haskell.org
Actual Problem
Dhall is a programmable configuration language. Despite as haskell programs which have haddock as a documentation generator tool, dhall doesn't have any official tool for that task.
Dhall programmers' workaround is to write package documentations in the header of their files, with no real syntax. Just information that let users or other developers know what is going on with that function/type-definition/whatsoever.
Goals of this Project
The main goal for this project is to create a command-line tool that receives as an input a dhall package (either a file or a directory tree) and outputs the generated documentation in (for the moment) HTML format. At the end of the summer program, dhall-docs cli tool will generate HTML docs that will have the following features:
- The actual documentation extracted from source code comments
- Browsing the original source code
- Type on hover
- Jump to definition