build_package_configs¶

documenteer.sphinxconfig.stackconf.build_package_configs(project_name, version=None, copyright=None, doxygen_xml_dirname=None)¶

Builds a dict of Sphinx configurations useful for the doc/conf.py files of individual LSST Stack packages.

The doc/conf.py of packages can ingest these configurations via:

from documenteer.sphinxconfig.stackconf import build_package_configs

_g = globals()
_g.update(build_package_configs(
    project_name='afw',
    version=lsst.afw.version.__version__))

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_namestr: Name of the package.
copyrightstr, optional: Copyright statement. Do not include the ‘Copyright (c)’ string; it’ll be added automatically.
versionstr: Version string. Use the __version__ member in a package’s version module.
doxygen_xml_dirnamestr: Path to doxygen-generated XML, allowing C++ APIs to be documented through breathe. If not set, the breathe sphinx extension will not be enabled.

Returns

cdict

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

_g = global()
_g.update(c)

Navigation

build_package_configs¶