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
81 Commits
1 Branch
0 Tags
861 KiB
Lean 57.2%
CSS 27.2%
JavaScript 15.1%
Shell 0.5%
 
 
 
 
Go to file
Gabriel Ebner 5ed0a8e99f fix: do not show top-level modules twice in navbar 2022-01-20 15:38:48 +01:00
.github/workflows feat: CI and auto documentation preview for mathlib4 2022-01-07 10:29:15 +01:00
DocGen4 fix: do not show top-level modules twice in navbar 2022-01-20 15:38:48 +01:00
static fix: do not show top-level modules twice in navbar 2022-01-20 15:38:48 +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: parameterize the URL root for links in the HTML 2022-01-07 10:56:39 +01:00
README.md feat: parameterize the URL root for links in the HTML 2022-01-07 10:56:39 +01:00
deploy_docs.sh feat: parameterize the URL root for links in the HTML 2022-01-07 10:56:39 +01:00
lakefile.lean chore: Initial Lake project 2021-12-12 13:37:18 +01:00
lean-toolchain feat: imports, imported by 2022-01-16 14:22:53 +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 the / is the root URL the HTML will refer to and 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