/doc-gen

Generate HTML documentation for mathlib and Lean

Primary LanguagePython

Lean HTML documentation generator

A tool to generate documentation for mathlib.

Requirements

This script is not Windows friendly.

It depends on features of Lean 3.5c added in leanprover-community/lean#81.

pip install markdown2 toml
leanpkg configure
update-mathlib

Make sure that olean files are generated for mathlib in _target, otherwise this will be extremely slow.

Usage

./gen_docs will create a directory html with the generated documentation.

The links will point to ./html/ as the root of the site. If you intend to host the site elsewhere, edit web_root in print_docs.py and use ./gen_docs -w.