About local help pages¶
makehelp command generates the local help pages of a
Lino site, that is, a set of static html pages in your
/media/cache/help directory (from where your web server will serve
them). These pages are Lino's answer to clicking on the ? button.
The local help pages system is based on a few conventions:
models and table views are documented as
autodocdirectives in prose style and using simplified naming in some other doctree
- simplified naming¶
The convention to document everything in the global name space of the
models.pyfile of a plugin without the submodule that implements it.
This is a tested document. The following instructions are used for initialization:
>>> import lino >>> lino.startup('lino_book.projects.min1.settings') >>> from lino.api.doctest import *
>>> rt.models.users.User <class 'lino.modlib.users.models.User'>
>>> rt.models.users.Users lino.modlib.users.ui.Users
>>> rt.models.users.UserTypes lino.modlib.users.choicelists.UserTypes