Documentation with Verso

Release Notes🔗

This section provides release notes about recent versions of Verso. When updating to a new version, please read the corresponding release notes. They may contain advice that will help you understand the differences with the previous version and upgrade your projects.

Verso versioning follows Lean's. This means that we release a new version for each Lean release, usually once per month. In particular, note that Verso doesn't follow the semantic versioning model.

Verso 4.29.0 (unreleased)🔗

Literate Programming🔗

PR #809 added support for a simple literate programming system, in which module docstrings are rendered as the text of a page. While no configuration is necessary to use it, aside from adding Verso as a dependency, some configuration is possible in order to customize aspects of the display. See its section in this guide for more details.

Docstrings via doc-gen4🔗

PR #776 implements an alternative backend for the docstring features in the manual genre. Instead of retrieving them from the in-memory Lean environment, they can be read from a SQLite database dumped by doc-gen4. This allows manuals written in Verso to use the Lean module system, which eliminates docstrings from environments for performance reasons, and it can enable features that require a global perspective, such as lists of instances. This very document now uses this new feature and has enabled the module system. See its section in this guide for more details.

Verso 4.28.0🔗

  • Add Release Notes / Changelog to Verso Users guide (@david-christiansen, @ejgallego, #708)

  • Fix infoview display for inline lean code (@david-christiansen, @ejgallego, #700)