build_pipelines_lsst_io_configs

documenteer.sphinxconfig.stackconf.build_pipelines_lsst_io_configs(*, project_name, copyright=None)

Build a dict of Sphinx configurations that populate the conf.py of the main pipelines_lsst_io Sphinx project for LSST Science Pipelines documentation.

The conf.py file can ingest these configurations via:

from documenteer.sphinxconfig.stackconf import            build_pipelines_lsst_io_configs

_g = globals()
_g.update(build_pipelines_lsst_io_configs(
    project_name='LSST Science Pipelines')

You can subsequently customize the Sphinx configuration by directly assigning global variables, as usual in a Sphinx config.py, e.g.:

copyright = '2016 Association of Universities for '
            'Research in Astronomy, Inc.'
Parameters:

  • project_name (str) – Name of the project

  • copyright (str, optional) – Copyright statement. Do not include the ‘Copyright (c)’ string; it’ll be added automatically.

Returns:

c – Dictionary of configurations that should be added to the conf.py global namespace via:

_g = global()
_g.update(c)

Return type:

dict