2021-11-11 01:41:28 +00:00
|
|
|
# doc-gen4
|
|
|
|
|
Document Generator for Lean 4
|
2021-12-12 12:27:38 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
You can call `doc-gen4` from the top of a Lake project like this:
|
|
|
|
|
```sh
|
2022-04-06 23:49:05 +00:00
|
|
|
$ /path/to/doc-gen4 Module
|
2021-12-12 12:27:38 +00:00
|
|
|
```
|
2022-04-06 23:49:05 +00:00
|
|
|
|
|
|
|
|
where `Module` is one or more of the top level modules you want to document.
|
2021-12-12 12:27:38 +00:00
|
|
|
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:
|
|
|
|
|
```sh
|
|
|
|
|
$ cd build/doc && python -m http.server
|
|
|
|
|
```
|
