About local help pages¶
The 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
autodoc
directives 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.py
file of a plugin without the submodule that implements it.For example when we say
lino.modlib.users.User
,lino.modlib.users.Users
orlino.modlib.users.UserTypes
, then we ignore the face that these classes are actually defined in different modules.
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