Document generator for my Bookshelf project
 
 
 
 
Go to file
Henrik Böving fbbdb21795 fix: remove redundant argument 2022-07-21 02:25:26 +02:00
.github/workflows feat: update CI and README 2022-06-20 23:04:03 +02:00
DocGen4 fix: remove redundant argument 2022-07-21 02:25:26 +02:00
static feat: Preparations to split doc-gen build process 2022-07-21 01:40:04 +02:00
.gitignore chore: update toolchain 2022-07-20 16:29:18 +02:00
DocGen4.lean feat: LeanInk all the files, HTML generation missing 2022-06-20 00:31:09 +02:00
LICENSE Initial commit 2021-11-10 17:41:28 -08:00
Main.lean fix: remove redundant argument 2022-07-21 02:25:26 +02:00
README.md feat: update CI and README 2022-06-20 23:04:03 +02:00
deploy_docs.sh feat: update CI and README 2022-06-20 23:04:03 +02:00
lakefile.lean chore: update toolchain 2022-07-20 16:29:18 +02:00
lean-toolchain chore: update toolchain 2022-07-20 16:29:18 +02:00

README.md

doc-gen4

Document Generator for Lean 4

Usage

You can call doc-gen4 from the top of a Lake project like this:

$ /path/to/doc-gen4 Module

where Module is one or more of the top level modules you want to document. The tool will then proceed to compile the project using lake (if that hasn't happened yet), analyze it and put the result in ./build/doc.

You can optionally provide the path to a LeanInk binary using the --ink flag which will make the tool produce Alectryon style rendered output along the usual documentation.

You could e.g. host the files locally with the built-in Python webserver:

$ cd build/doc && python -m http.server