atelier.sphinxconf

Sphinx extensions and a configure() function used to build the documentation trees maintained by us.

base

Basic extension

dirtables

Defines the directory, tickets_table and entry_intro directives.

refstothis

A Sphinx extension which adds the refstothis directive.

insert_input

Defines the InsertInputDirective class and some subclasses, installing the py2rst directive.

sigal_image

Defines the sigal_image directive.

complex_tables

Defines the textimage and complextable directives.

blog

This Sphinx extension defines the blogger_year and blogger_index directives.

interproject

Defines the atelier.sphinxconf.interproject.configure() function.

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

Functions

configure(globals_dict)

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

version2rst(self, m)

used in docs/released/index.rst

atelier.sphinxconf.configure(globals_dict)

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

Usage: add the following two lines at the beginning of your conf.py:

from atelier.sphinxconf import configure
configure(globals())

Incomplete list of settings that will be set:

  • templates_path

  • extensions, extlinks and intersphinx_mapping are initialized but empty

  • master_doc = ‘index’

  • source_suffix = ‘.rst’

  • primary_domain = ‘py’

  • pygments_style = ‘sphinx’

  • version and release from SETUP_INFO

  • exclude_trees = [‘old’, ‘include’, ‘.build’]

atelier.sphinxconf.version2rst(self, m)

used in docs/released/index.rst