conf Namespace Reference

Variables
str	project = "pex_config"
str	html_title = project
str	html_short_title = project
dict	doxylink = {}
list	exclude_patterns = ["changes/*"]
list	nitpick_ignore
list	nitpick_ignore_regex

Detailed Description

Sphinx configuration file for an LSST stack package.

This configuration only affects single-package Sphinx documenation builds.

Variable Documentation

nitpick_ignore

list conf.nitpick_ignore

Initial value:

=  [
    ("py:obj", "lsst.daf.base.PropertySet"),
    ("py:obj", "lsst.pex.config.Field.doc"),  # Cannot make the doc field property appear in docs.
    ("py:obj", "lsst.pex.config.List"),  # Private class.
    ("py:obj", "RegistryInstanceDict"),  # Private class.
    ("py:obj", "lsst.resources.ResourcePathExpression"),
    ("py:class", "lsst.pex.config.dictField.Dict"),
    ("py:class", "lsst.pex.config.listField.List"),
    ("py:class", "ActionTypeVar"),
]

nitpick_ignore_regex

list conf.nitpick_ignore_regex

Initial value:

=  [
    ("py:class", "a set-like.*"),  # collections.abc.Mapping inheritance.
    ("py:class", r"D\[k\] if k .*"),  # collections.abc.Mapping inheritance.
    ("py:class", "an object providing.*"),  # collections.abc.Mapping inheritance.
    ("py:(obj|class)", "lsst.pex.config..*TypeVar"),  # Sphinx does not like TypeVar.
    ("py:obj", "ConfigField.(item|dict)Check"),  # Cannot make the check properties appear in docs.
    ("py:(obj|class)", ".*ConfigInstanceDict"),  # Private class.
]