r
/
bookshelf-doc
mirror of https://github.com/jrpotter/bookshelf-doc
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Document generator for my Bookshelf project
50 Commits
1 Branch
0 Tags
861 KiB
Lean 57.2%
CSS 27.2%
JavaScript 15.1%
Shell 0.5%
 
 
 
 
Go to file
Henrik Böving 5e0956c4b0 feat: Proper linking of all constants 
Previously constants in function applications where either not linked
at all or linked in a weird way, this change fixes it by making use of
a (as of now umerged) compiler modification as well as Lean.Widget's
TaggedText.
 		2022-01-03 14:25:50 +01:00
DocGen4 feat: Proper linking of all constants 2022-01-03 14:25:50 +01:00
static feat: import nav.js 2021-12-13 21:36:21 +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: Some more progress logging 2021-12-15 12:02:05 +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 feat: Proper linking of all constants 2022-01-03 14:25:50 +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