Automated Documentation generation from source code.

edwinb / Idris2-boot

A dependently typed programming language, a successor to Idris

https://idris-lang.org/

Other

902 stars 57 forks source link

Automated Documentation generation from source code. #295

Open jeetu7 opened 4 years ago

jeetu7 commented 4 years ago

This issue pertains to the mechanism for genreating html documentation automatically from source idr files. It might be something like hackage/haddock or python-sphinx-autodoc. Here we can document the approaches and progress till we have something implemented. Afterwards, further sub-issuse can be created.

The documentation extracted can be linked with browsable docs of the source code. #294

clayrat commented 4 years ago

Note that Idris1 already supports this with --mkdoc cmdline option, but it is broken due to https://github.com/idris-lang/Idris-dev/issues/2161