Document generator for my Bookshelf project
 
 
 
 
Go to file
Henrik Böving 2128e789ca
Merge pull request #49 from leanprover/ctor-field-docs
Structure field doc strings
2022-04-09 22:34:04 +02:00
.github/workflows feat: CI and auto documentation preview for mathlib4 2022-01-07 10:29:15 +01:00
DocGen4 feat: Render doc comments for structure fields 2022-04-09 21:39:34 +02:00
static feat: Render doc comments for structure fields 2022-04-09 21:39:34 +02:00
.gitignore chore: Initial Lake project 2021-12-12 13:37:18 +01:00
DocGen4.lean feat: Attributes 2022-02-13 03:32:53 +01:00
LICENSE Initial commit 2021-11-10 17:41:28 -08:00
Main.lean cleanup code 2022-04-07 00:48:12 +01:00
README.md update README 2022-04-07 00:49:05 +01:00
deploy_docs.sh modify deploy_docs to not need relative path 2022-04-07 00:44:49 +01:00
lakefile.lean chore: upgrade compiler version 2022-04-09 19:30:33 +02:00
lean-toolchain chore: upgrade compiler version 2022-04-09 19:30:33 +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 could e.g. host the files locally with the built-in Python webserver:

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