Document generator for my Bookshelf project
 
 
 
 
Go to file
Henrik Böving dbbe11da0a chore: In file licensing 2021-12-12 13:38:31 +01:00
DocGen4 chore: In file licensing 2021-12-12 13:38:31 +01:00
static feat: HTML Index + CSS 2021-12-12 13:38:31 +01:00
.gitignore chore: Initial Lake project 2021-12-12 13:37:18 +01:00
DocGen4.lean feat: HTML Index + CSS 2021-12-12 13:38:31 +01:00
LICENSE Initial commit 2021-11-10 17:41:28 -08:00
Main.lean feat: HTML Index + CSS 2021-12-12 13:38:31 +01:00
README.md doc: Basic usage in README 2021-12-12 13:38:31 +01:00
lakefile.lean chore: Initial Lake project 2021-12-12 13:37:18 +01:00
lean-toolchain chore: Update compiler and fix minor breaking change 2021-12-12 13:38:31 +01: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 could e.g. host the files locally with the built-in Python webserver:

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