bookshelf-doc/README.md

17 lines
592 B
Markdown
Raw Normal View History

2021-11-11 01:41:28 +00:00
# doc-gen4
Document Generator for Lean 4
2021-12-12 12:27:38 +00:00
## Usage
2022-08-11 19:37:10 +00:00
`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:
2021-12-12 12:27:38 +00:00
```
2022-08-11 19:37:10 +00:00
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"
2022-07-21 16:32:09 +00:00
```
2022-08-11 19:37:10 +00:00
Then you can generate documentation for an entire library using:
2022-07-21 16:32:09 +00:00
```
2022-08-11 19:37:10 +00:00
lake -Kenv=dev build Test:docs
2022-07-21 16:32:09 +00:00
```
2022-08-11 19:37:10 +00:00
If you have multiple libraries you want to generate documentation for
the recommended way right now is to run it for each library.