Automated Documentation generation from source code.

[edwinb]

Issue by jeetu7
Friday Apr 17, 2020 at 10:07 GMT
Originally opened as edwinb/Idris2-boot#295

---

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

[edwinb]

Comment by clayrat
Friday Apr 17, 2020 at 11:37 GMT

---

Note that Idris1 already supports this with --mkdoc cmdline option, but it is broken due to idris-lang/Idris-dev#2161

[edwinb]

This exists now, although there is more to do - browsable source code would be nice for example. Even so, I think we can close this one now.