Skip to content

bryangingechen/doc-gen

 
 

Repository files navigation

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 -r requirements.txt
rm -rf _target
leanproject get-mathlib-cache

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 / as the root of the site. I typically host a server from the html directory with python3 -m http.server. If you intend to host the site somewhere else than the root, call for example ./gen_docs -w 'https://lean.com/my-documentation/'.

gen_docs -l will symlink the css file, so you can edit style.css in the root directory without regenerating anything. This is useful for local development.

About

Generate HTML documentation for mathlib and Lean

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 28.1%
  • HTML 21.5%
  • CSS 20.2%
  • Lean 18.6%
  • JavaScript 8.2%
  • Shell 3.4%