LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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.