lsst.pex.config g733a212e47+2a59df914c
Loading...
Searching...
No Matches
Variables
conf Namespace Reference

Variables

string project = "pex_config"
 
string html_title = project
 
string html_short_title = project
 
dictionary 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:
1= [
2 ("py:obj", "lsst.daf.base.PropertySet"),
3 ("py:obj", "lsst.pex.config.Field.doc"), # Cannot make the doc field property appear in docs.
4 ("py:obj", "lsst.pex.config.List"), # Private class.
5 ("py:obj", "RegistryInstanceDict"), # Private class.
6 ("py:class", "lsst.pex.config.dictField.Dict"),
7 ("py:class", "lsst.pex.config.listField.List"),
8 ("py:class", "ActionTypeVar"),
9]

◆ nitpick_ignore_regex

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