lino.sphinxcontrib.actordoc

A Sphinx extension used to write multilingual user documentation for a Lino application.

.. lino2rst::

Execute Python code and process the output as reStructuredText source code. This is like py2rst but with the following names defined:

Settings

The Django settings module which is active while building the docs.

Dd

The lino.api.dd module.

Rt

The lino.api.rt module.

Plus the app_label of each installed plugin.

.. fields_list::

Render a bullet list of the fields in a given model. The first word of the content is the model. If there are any other words, then these are field names. If no field names are specified, all fields of the model are included.

:menupath:

Render the given menu command specifier as a menuselection role.

.. actor::

Usage:

.. actor:: app_name[.ActorName][.data_element_name]

  Optional introduction text.

Insert the full description of the specified data dictionary item. If the name contains no ".", then it is the name of a Plugin. If the name contains one ".", then it is the name of an Actor or a Model. If the name contains two ".", then it is the name of a data element of that Actor or Model (data elements can be fields or actions)

:ddref:

(Deprecated) Insert a reference to the named data dictionary item. The visible text will be automatically in the right language in multilingual userdocs.

(This module's source code is available here.)

Functions

actions_ul(action_list)

actor_name(a)

actor_ref(rpt[, text])

actors_overview_ul(model_reports)

app_name(a)

fields_table(fields)

fields_ul(fields)

fieldtype(f)

form_lines()

get_actor_description(self)

self is the actor

menupath_role(typ, rawtext, text, *args, ...)

menuselection(mi)

model_name(m)

model_ref(m[, text])

old_fieldtype(f)

resolve_name(name)

rptlist(l)

setup(app)

typeref(cls)

Classes

ActorDirective(name, arguments, options, ...)

ActorsOverviewDirective(name, arguments, ...)

CurrentLanguage(name, arguments, options, ...)

Tell Sphinx to switch to the specified language until the end of this document.

CurrentProject(name, arguments, options, ...)

Tell Sphinx to switch to the specified project until the end of this document.

FormDirective(name, arguments, options, ...)

Lino2rstDirective(name, arguments, options, ...)

Defines the lino2rst directive.

ShowFieldsDirective(name, arguments, ...)

TempDataDirective(name, arguments, options, ...)

ddrefRole([fix_parens, lowercase, ...])

lino.sphinxcontrib.actordoc.get_actor_description(self)

self is the actor

class lino.sphinxcontrib.actordoc.CurrentLanguage(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: lino.sphinxcontrib.actordoc.TempDataDirective

Tell Sphinx to switch to the specified language until the end of this document.

class lino.sphinxcontrib.actordoc.CurrentProject(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: lino.sphinxcontrib.actordoc.TempDataDirective

Tell Sphinx to switch to the specified project until the end of this document.

class lino.sphinxcontrib.actordoc.Lino2rstDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: atelier.sphinxconf.insert_input.Py2rstDirective

Defines the lino2rst directive.