About the Lino documentation¶

The Lino documentation is written in Sphinx and distributed in several doctrees.

The source code of the Lino documentation is published in code repositories as free content under the same licence as the source code.

Lino documentation is designed for different audiences: stakeholders, consultants, end users, key users, support providers, application developers, contributing developers and hosting providers.

developer guide¶

A doctree designed to be used by application developers.

user guide¶

A doctree designed to be used by end users.

doctree¶

A tree of Sphinx documentation pages.

reference documentation¶

A section of documentation pages that are intermediate between developer guide and user guide.

Reference documentation is not only for developers, it can be a valuable help for support providers and motivated key users.

Reference docs contain class descriptions for database models and data views.

Reference docs are not translated like the user guide.

local help pages¶

A doctree that is automatically generated by every Lino site. These pages are what opens when you click the help button (?).