Fast Idris2 Doc Browser with Fuzzy Matching
cbb5a425 — Johann Rudloff 1 year, 6 months ago
Include the version of the _documented_ soruce code in the output
bafccda6 — Johann Rudloff 1 year, 11 months ago
Update docs & scripts to account for recent Idris2 upstream
a6d17f6d — Johann Rudloff 2 years ago
Prevent duplicate index entries (e.g. interface implementations)


browse  log 



You can also use your local clone with git send-email.

#Idris2 Quickdocs

This is an index generator and fast documentation browser for Idris2.

#Live Demo

A demo of this is hosted at https://idris2docs.sinyax.net


To generate the documentation index, you need Python 3, poetry and a recent (>= 0.5.1) version of Idris 2.


Updating and serving the docs is a bit rought for now, but all the pieces are available.

Run poetry install to install dependencies, then you can run the following:

IDRIS2_EXECUTABLE=path/to/idris2 IDRIS2_SRC=path/to/idris2/source/code ./rebuild_all.sh

The you can serve the current directory (don't do this in production!):

python3 -mhttp.server 8001

And your docs will be served at