atelier.sphinxconf.dirtables

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

Defines the directory, tickets_table and entry_intro directives.

.. directory::

Inserts a table containing three columns ‘title’, ‘author’ and ‘date’, and one row for each .rst file found in this directory (except for the calling file).

.. tickets_table::

This is used e.g. to build http://lino-framework.org/tickets

.. entry_intro::

This doesn’t yet work unfortunately.

Functions

abspath(path)	Return an absolute path.
dirname(p)	Returns the directory component of a pathname
docname_join(basedocname, docname)
join(a, *p)	Join two or more pathname components, inserting ‘/’ as needed.
patfilter(names, pat)	Return the subset of the list NAMES that match PAT.
rel_docname(a, b)	>>> print(rel_docname('tickets/index','tickets/2'))
render_entry(tplname, context)
setup(app)

Classes

DirectoryTable(name, arguments, options, ...)
Entry(docname, title, meta)
EntryIntro(name, arguments, options, ...)
Environment([block_start_string, ...])	The core component of Jinja is the Environment.
FileSystemLoader(searchpath[, encoding, ...])	Loads templates from the file system.
InsertInputDirective(name, arguments, ...)	Base class for directives that work by generating rst markup to be forwarded to state_machine.insert_input().
TicketsTable(name, arguments, options, ...)

Exceptions

TemplateNotFound(name[, message])

Raised if a template does not exist.

atelier.sphinxconf.dirtables.rel_docname(a, b)

>>> print(rel_docname('tickets/index','tickets/2'))
2
>>> print(rel_docname('tickets/index','/todo/index'))
/todo/index