r
/
bookshelf-doc
mirror of https://github.com/jrpotter/bookshelf-doc
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update README

main
Siddharth Bhat 2022-04-07 00:49:05 +01:00
parent 9570f25312
commit 10ed2d489d
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -4,10 +4,10 @@ Document Generator for Lean 4
## Usage
You can call `doc-gen4` from the top of a Lake project like this:
```sh
$ /path/to/doc-gen4 / Module
$ /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.
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: