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
283 Commits
1 Branch
0 Tags
861 KiB
Lean 57.2%
CSS 27.2%
JavaScript 15.1%
Shell 0.5%
 
 
 
 
Go to file
Sebastian Ullrich 4a7c5e214a
chore: drop unused import 
I didn't even know one could import modules from executables! Not sure how to feel about that.
 		2022-08-12 23:04:36 +02:00
.github/workflows fix: pipeline for new build 2022-08-11 23:49:30 +02:00
DocGen4 Merge branch 'main' into LeanInkLink 2022-08-11 23:51:26 +02:00
lean_packages chore: update toolchain 2022-08-11 18:30:28 +02:00
static feat: instances for 2022-07-23 15:40:08 +02:00
.gitignore feat: importedBy via Javascript 2022-07-22 16:56:51 +02:00
DocGen4.lean chore: update toolchain 2022-08-11 18:30:28 +02:00
LICENSE Initial commit 2021-11-10 17:41:28 -08:00
Main.lean feat: implement facet 2022-08-11 22:58:25 +02:00
README.md feat: implement facet 2022-08-11 22:58:25 +02:00
deploy_docs.sh fix: pipeline for new build 2022-08-11 23:49:30 +02:00
lakefile.lean chore: drop unused import 2022-08-12 23:04:36 +02:00
lean-toolchain chore: update toolchain 2022-08-11 18:30:28 +02:00

README.md

doc-gen4

Document Generator for Lean 4

Usage

doc-gen4 is the easiest to use via its custom Lake facet, in order to do this you have to add it to your lakefile.lean like this:

meta if get_config? env = some "dev" then -- dev is so not everyone has to build it
require «doc-gen4» from git "https://github.com/leanprover/doc-gen4" @ "main"

Then you can generate documentation for an entire library using:

lake -Kenv=dev build Test:docs

If you have multiple libraries you want to generate documentation for the recommended way right now is to run it for each library.