Skip to content

Commit 83b11f3

Browse files
committed
Added docs for DNAMeasurements
1 parent 65c06df commit 83b11f3

File tree

2 files changed

+308
-7
lines changed

2 files changed

+308
-7
lines changed

docs/conf.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,15 @@
100100

101101
# Immaterial toc adjustments
102102
object_description_options = [
103-
("py:.*",
103+
(
104+
"py:.*",
104105
{
105106
"include_fields_in_toc": False,
106107
"include_rubrics_in_toc": False
107108
}
108109
),
109-
("py:parameter",
110+
(
111+
"py:parameter",
110112
{
111113
"include_in_toc": False
112114
}
@@ -123,7 +125,9 @@
123125
napoleon_google_docstring = False
124126
napoleon_use_ivar = True
125127
napoleon_type_aliases = {
126-
"GeoComResponse": "~geocompy.GeoComResponse"
128+
"GeoComResponse": "~geocompy.GeoComResponse",
129+
"GsiOnlineResponse": "~geocompy.GsiOnlineResponse",
130+
"datetime": "~datetime.datetime"
127131
}
128132

129133
python_display_short_literal_types = True
@@ -142,8 +146,8 @@
142146
("py:obj", r"[a-zA-Z]{3}\.\w+")
143147
}
144148

145-
# GitHub source linking
146-
def linkcode_resolve(domain, info):
149+
150+
def linkcode_resolve(domain, info): # GitHub source linking
147151
if domain != 'py':
148152
return None
149153
if not info['module']:
@@ -154,6 +158,7 @@ def linkcode_resolve(domain, info):
154158
f"geocompy/tree/main/src/{filename:s}.py"
155159
)
156160

161+
157162
latex_documents = [
158163
(
159164
"latexindex", "geocompy.tex",

0 commit comments

Comments
 (0)