LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
conf Namespace Reference

Variables

str project = "afw"
 
str html_title = project
 
str html_short_title = project
 
 _g = globals()
 
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 documentation builds.
For more information, see:
https://developer.lsst.io/stack/building-single-package-docs.html
Sphinx configuration file for an LSST stack package.

This configuration only affects single-package Sphinx documentation builds.
Sphinx configuration file for an LSST stack package.

This configuration only affects single-package Sphinx documenation builds.

Variable Documentation

◆ _g

conf._g = globals()
protected

Definition at line 10 of file conf.py.

◆ doxylink

dict conf.doxylink = {}

Definition at line 14 of file conf.py.

◆ exclude_patterns

list conf.exclude_patterns = ["changes/*"]

Definition at line 13 of file conf.py.

◆ html_short_title

str conf.html_short_title = project

Definition at line 13 of file conf.py.

◆ html_title

str conf.html_title = project

Definition at line 12 of file conf.py.

◆ 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]

Definition at line 22 of file conf.py.

◆ 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]

Definition at line 31 of file conf.py.

◆ project

str conf.project = "afw"

Definition at line 10 of file conf.py.