Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Automated Documentation generation from source code. #295

Open
jeetu7 opened this issue Apr 17, 2020 · 1 comment
Open

Automated Documentation generation from source code. #295

jeetu7 opened this issue Apr 17, 2020 · 1 comment
Labels
Feature request

Comments

@jeetu7
Copy link
Contributor

jeetu7 commented Apr 17, 2020

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
Copy link
Contributor

clayrat commented Apr 17, 2020

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

@edwinb edwinb mentioned this issue May 20, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@edwinb @clayrat @jeetu7