search

ziman / lightyear

Parser combinators for Idris
Other
238 stars 43 forks source link

documentation #45

Open langston-barrett opened 8 years ago

langston-barrett commented 8 years ago

Is there any documentation available for this library?

langston-barrett commented 8 years ago

Looks like there's IdrisDoc, which I just learned about :-) might be helpful to point newbies in that direction!

leostera commented 7 years ago

@siddharthist mind dropping the link here?

jfdm commented 7 years ago

@ostera You will be interested in:

When installing idris packages you can also innvoke: idris --installdoc <pkg name> that will install the documentation for he package (html) into idris --docdir. Or idris --mkdoc <pkg name> that will dump the documentation into the project's root. All the documentation in the generate docs are accessible from Idris' REPL, and various IDE mode's.

Any question's please feel free to lurk in #idris on freenode, or send a question to the mailing list.