forked from IMAP-Science-Operations-Center/imap_processing
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconf.py
More file actions
148 lines (122 loc) · 5.12 KB
/
Copy pathconf.py
File metadata and controls
148 lines (122 loc) · 5.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
"""
Configuration file for the Sphinx documentation builder.
This file only contains a selection of the most common options. For a full
list see the documentation:
https://www.sphinx-doc.org/en/master/usage/configuration.html
"""
# -- Path setup --------------------------------------------------------------
import sys
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use resolve() to make it absolute, like shown here.
#
from pathlib import Path
import imap_processing
sys.path.insert(0, Path("../../imap_processing").resolve())
# -- Project information -----------------------------------------------------
project = "imap_processing"
copyright = "2024, Regents of the University of Colorado"
author = "IMAP Science Operations Center"
# The full version, including alpha/beta/rc tags
release = imap_processing.__version__
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosectionlabel",
"sphinx.ext.autosummary",
"sphinx.ext.intersphinx", # Link to other projects' documentation
"sphinx.ext.githubpages", # Helpful for publishing to gh-pages
"sphinx.ext.napoleon",
"sphinxcontrib.openapi",
"numpydoc",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "pydata_sphinx_theme"
html_logo = "_static/imap-mark-hor-multicolor-dark.png"
html_theme_options = {
"navigation_with_keys": True,
"github_url": "https://github.com/IMAP-Science-Operations-Center/imap_processing",
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# Autosummary
autosummary_generate = True
# Do not generate separate pages for class methods
numpydoc_show_class_members = False
intersphinx_mapping = {
"numpy": ("https://numpy.org/doc/stable/", None),
"pandas": ("https://pandas.pydata.org/docs/", None),
"pytest": ("https://pytest.org/en/stable/", None),
"python": ("https://docs.python.org/3/", None),
"xarray": ("https://docs.xarray.dev/en/stable/", None),
"space_packet_parser": (
"https://space-packet-parser.readthedocs.io/en/stable/",
None,
),
}
# Reference targets not found
nitpicky = True
# Some inherited method targets aren't found through intersphinx
# TODO: comeback and clean this up later
nitpick_ignore_regex = [
(r"py:.*", r".*APID\..*"),
(r"py:.*", r".*Scitype.*"),
(r"py:.*", r".*Mode.*"),
(r"py:.*", r".*SWAPIMODE.*"),
(r"py:.*", r".*TriggerDescription.*"),
(r"py:.*", r".*IntEnum.*"),
(r"py:.*", r".*space_packet_parser.*"),
(r"py:.*", r".*CoDICECompression.*"),
(r"py:.*", r".*SegmentedPacketOrder.*"),
(r"py:.*", r".*codice.utils.*"),
(r"py:.*", r".*RectangularSkyMap.*"),
(r"py:.*", r".*AbstractSkyMap.*"),
(r"py:.*", r".*MapDescriptor.*"),
(r"py:.*", r".*.lo.l0.utils.*"),
(r"py:.*", r".*.lo.l0.data_classes.*"),
(r"py:.*", r".*.hi.*.[A-Z][a-zA-Z]*.*"), # match any hi CamelCase class
(r"py:.*", r".*.hit.l0.utils.*"),
(r"py:.*", r".*.hit.l0.data_classes.*"),
(r"py:.*", r".*.hit.l1a.*"),
(r"py:.*", r".*InitVar*"),
(r"py:.*", r".*.glows.utils.constants.TimeTuple.*"),
(r"py:.*", r".*glows.utils.constants.DirectEvent.*"),
(r"py:.*", r".*numpy.int.*"),
(r"py:.*", r".*np.ndarray.*"),
(r"py:.*", r".*numpy._typing._array_like._ScalarType_co.*"),
(r"py:.*", r".*idex.l1a.TRIGGER_DESCRIPTION.*"),
(r"py:.*", r".*idex.l1b.TriggerOrigin.*"),
(r"py:.*", r".*idex.l1b.EventMessage.*"),
(r"py:.*", r".*idex.l2a.BaselineNoiseTime.*"),
(r"py:.*", r".*PacketProperties"),
(r"py:.*", r".*.spice.geometry.SpiceBody.*"),
(r"py:.*", r".*.spice.geometry.SpiceFrame.*"),
(r"py:class", r"numpy._typing.*"),
(r"py:class", r"^numpy\.(u?int(?:8|16|32|64))$"),
(r"py:.*", r".*ProcessingInputCollection"),
(r"py:.*", r"imap_data_access.*"),
(r"py:class", r"pandas\.core\.frame\.DataFrame"),
]
# Ignore the inherited members from the <instrument>APID IntEnum class
numpydoc_show_inherited_class_members = {
"imap_processing.hit.l0.hit_l1a_decom.HitAPID": False,
"imap_processing.codice.utils.CODICEAPID": False,
}
# Suppress specific warnings
suppress_warnings = [
"autosectionlabel.*"
] # Duplicate label use (e.g. imap_processing.codice.codice_l0)