LSST Applications g025927ac6c+147a24b06b,g0265f82a02+944b3770bc,g043fd6e71d+4d6ecfaaae,g08227fae09+5919da0d66,g177eaadcb2+1e63ef9e19,g2bbee38e9b+944b3770bc,g337abbeb29+944b3770bc,g33a09d4741+186f0dc348,g3ddfee87b4+186f0dc348,g41b076d227+8672027aa3,g44018dc512+944b3770bc,g4544ed029c+e03729b094,g50ff169b8f+f6908454ef,g5f6f997623+81bc2a20b4,g7a18d25bdf+0cbdeccc59,g7d743f24c3+c83252e8d3,g7dcc1e6542+ba5da2067c,g858d7b2824+5919da0d66,g98ffbb4407+81bc2a20b4,g9ddcbc5298+7f7571301f,ga1e77700b3+495ad9f5da,gae46bcf261+944b3770bc,gb700894bec+c2dffffaaf,gbeb006f7da+0b63d91d4b,gc86a011abf+5919da0d66,gcb20ee0ffd+bc2f88c280,gcf0d15dbbd+186f0dc348,gd162630629+b92117bb3f,gdaeeff99f8+0d8dbea60f,gdb4ec4c597+944b3770bc,ge3564fa9f0+151886bce0,gee10cc3b42+81bc2a20b4,gf041782ebf+f93289ef23,gf1cff7945b+5919da0d66,gf748b16de2+c7df7670f8,w.2023.52
LSST Data Management Base Package
Loading...
Searching...
No Matches
conf.py
Go to the documentation of this file.
1"""Sphinx configuration file for an LSST stack package.
2
3This configuration only affects single-package Sphinx documenation builds.
4"""
5
6from documenteer.conf.pipelinespkg import * # noqa: F403, import *
7
8project = "pex_config"
9html_theme_options["logotext"] = project # noqa: F405, unknown name
10html_title = project
11html_short_title = project
12doxylink = {}
13exclude_patterns = ["changes/*"]
14
15# Add pipelines.lsst.io to the intersphinx configuration.
16# NOTE: we might want to be more sophisticated about mapping corresponding
17# versions of the Pipelines and astro_metadata_translator. This technique will
18# mostly work if the Pipelines and astro_metadata_translator are developed
19# concurrently.
20intersphinx_mapping["lsst"] = ("https://pipelines.lsst.io/v/daily/", None) # noqa
21
22nitpick_ignore = [
23 ("py:obj", "lsst.daf.base.PropertySet"),
24 ("py:obj", "lsst.pex.config.Field.doc"), # Cannot make the doc field property appear in docs.
25 ("py:obj", "lsst.pex.config.List"), # Private class.
26 ("py:obj", "RegistryInstanceDict"), # Private class.
27 ("py:class", "lsst.pex.config.dictField.Dict"),
28 ("py:class", "lsst.pex.config.listField.List"),
29 ("py:class", "ActionTypeVar"),
30]
31nitpick_ignore_regex = [
32 ("py:class", "a set-like.*"), # collections.abc.Mapping inheritance.
33 ("py:class", r"D\[k\] if k .*"), # collections.abc.Mapping inheritance.
34 ("py:class", "an object providing.*"), # collections.abc.Mapping inheritance.
35 ("py:(obj|class)", "lsst.pex.config..*TypeVar"), # Sphinx does not like TypeVar.
36 ("py:obj", "ConfigField.(item|dict)Check"), # Cannot make the check properties appear in docs.
37 ("py:(obj|class)", ".*ConfigInstanceDict"), # Private class.
38]