4a3e22490f
Previously we would print all names with macro scopes (after removing the macro related stuff) which could cause confusion if for example there was an actual parameter named `a` and one named `a` but autogenerated by Lean itself. Now we only try to print names with macro scopes iff they are names of type class parameters. Otherwise the rest of the Expr is moved behind the :. |
||
|---|---|---|
| .github/workflows | ||
| DocGen4 | ||
| static | ||
| .gitignore | ||
| DocGen4.lean | ||
| LICENSE | ||
| Main.lean | ||
| README.md | ||
| deploy_docs.sh | ||
| lakefile.lean | ||
| lean-toolchain | ||
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