atelier.sphinxconf.dirtables

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 was used e.g. to build http://lino-framework.org/tickets until 20190329 (where we threw it away as it failed in Sphinx 2)

.. entry_intro::

This doesn’t yet work unfortunately. Was here until 20190329 (where we threw it away as it failed in Sphinx 2).

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

Functions

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)

atelier.sphinxconf.dirtables.rel_docname(a, b)
>>> print(rel_docname('tickets/index','tickets/2'))
2
>>> print(rel_docname('tickets/index','/todo/index'))
/todo/index