lino.sphinxcontrib

Some extensions for Sphinx.

base

Adds Lino-specific Sphinx setup.

logo

Sets the html_logo and html_favicon for all Lino-related sites.

actordoc

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

help_texts_extractor

Causes one or several help_texts.py files to be generated after each complete build of the doctree.

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

Functions

configure(globals_dict[, ...])

Adds to your conf.py an arbitrary series of things that all Lino docs configuration files have in common.

lino.sphinxcontrib.configure(globals_dict, django_settings_module=None, project=None)

Adds to your conf.py an arbitrary series of things that all Lino docs configuration files have in common.

To be called from inside the Sphinx conf.py file as follows:

from lino.sphinxcontrib import configure
configure(globals())

This will also call atelier.sphinxconf.configure(), and then adds more things specific to the Lino framework.

This adds the main Lino doctrees to your intersphinx_mapping.

You can specify an additional positional argument django_settings_module (the name of a Django settings module). If this argument is specified, call lino.startup() with it.