Skip to content

Commit 6530b6e

Browse files
pawamoypawamoy
committed
docs: Update links to documentation in JSON schema
1 parent 12fb68d commit 6530b6e

File tree

1 file changed

+60
-44
lines changed

1 file changed

+60
-44
lines changed

‎docs/schema.json

+60-44
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
},
4343
"paths": {
4444
"title": "Local absolute/relative paths (relative to mkdocs.yml) to search packages into.",
45-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#global-only-options",
45+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#paths",
4646
"type": "array",
4747
"items": {
4848
"type": "string",
@@ -51,7 +51,7 @@
5151
},
5252
"load_external_modules": {
5353
"title": "Load external modules to resolve aliases.",
54-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#global-only-options",
54+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#load_external_modules",
5555
"type": "boolean",
5656
"default": false
5757
},
@@ -62,195 +62,206 @@
6262
"properties": {
6363
"docstring_style": {
6464
"title": "The docstring style to use when parsing docstrings.",
65-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
66-
"enum": ["google", "numpy", "sphinx"],
65+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_style",
66+
"enum": [
67+
"google",
68+
"numpy",
69+
"sphinx"
70+
],
6771
"default": "google"
6872
},
6973
"docstring_options": {
7074
"title": "The options for the docstring parser.",
71-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
75+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_options",
7276
"default": null,
7377
"items": {
7478
"$ref": "https://raw.githubusercontent.com/mkdocstrings/griffe/master/docs/schema-docstrings-options.json"
7579
}
7680
},
7781
"show_root_heading": {
7882
"title": "Show the heading of the object at the root of the documentation tree.",
79-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
83+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_heading",
8084
"type": "boolean",
8185
"default": false
8286
},
8387
"show_root_toc_entry": {
8488
"title": "If the root heading is not shown, at least add a ToC entry for it.",
85-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
89+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_toc_entry",
8690
"type": "boolean",
8791
"default": true
8892
},
8993
"show_root_full_path": {
9094
"title": "Show the full Python path for the root object heading.",
91-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
95+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_full_path",
9296
"type": "boolean",
9397
"default": true
9498
},
9599
"show_root_members_full_path": {
96100
"title": "Show the full Python path of the root members.",
97-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
101+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_root_members_full_path",
98102
"type": "boolean",
99103
"default": false
100104
},
101105
"show_object_full_path": {
102106
"title": "Show the full Python path of every object.",
103-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
107+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_object_full_path",
104108
"type": "boolean",
105109
"default": false
106110
},
107111
"show_category_heading": {
108112
"title": "When grouped by categories, show a heading for each category.",
109-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
113+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#show_category_heading",
110114
"type": "boolean",
111115
"default": false
112116
},
113117
"show_if_no_docstring": {
114118
"title": "Show the object heading even if it has no docstring or children with docstrings.",
115-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
119+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_if_no_docstring",
116120
"type": "boolean",
117121
"default": false
118122
},
119123
"show_signature": {
120124
"title": "Show methods and functions signatures.",
121-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
125+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#show_signature",
122126
"type": "boolean",
123127
"default": true
124128
},
125129
"show_signature_annotations": {
126130
"title": "Show the type annotations in methods and functions signatures.",
127-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
131+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#show_signature_annotations",
128132
"type": "boolean",
129133
"default": false
130134
},
131135
"separate_signature": {
132136
"title": "Whether to put the whole signature in a code block below the heading. If Black is installed, the signature is also formatted using it.",
133-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
137+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#separate_signature",
134138
"type": "boolean",
135139
"default": false
136140
},
137141
"line_length": {
138142
"title": "Maximum line length when formatting code/signatures.",
139-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
143+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#line_length",
140144
"type": "integer",
141145
"default": 60
142146
},
143147
"merge_init_into_class": {
144148
"title": "Whether to merge the `__init__` method into the class' signature and docstring.",
145-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
149+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#merge_init_into_class",
146150
"type": "boolean",
147151
"default": false
148152
},
149153
"show_docstring_attributes": {
150154
"title": "Whether to display the \"Attributes\" section in the object's docstring.",
151-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
155+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_attributes",
152156
"type": "boolean",
153157
"default": true
154158
},
155159
"show_docstring_description": {
156160
"title": "Whether to display the textual block (including admonitions) in the object's docstring.",
157-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
161+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_description",
158162
"type": "boolean",
159163
"default": true
160164
},
161165
"show_docstring_examples": {
162166
"title": "Whether to display the \"Examples\" section in the object's docstring.",
163-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
167+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_examples",
164168
"type": "boolean",
165169
"default": true
166170
},
167171
"show_docstring_other_parameters": {
168172
"title": "Whether to display the \"Other Parameters\" section in the object's docstring.",
169-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
173+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_other_parameters",
170174
"type": "boolean",
171175
"default": true
172176
},
173177
"show_docstring_parameters": {
174178
"title": "Whether to display the \"Parameters\" section in the object's docstring.",
175-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
179+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_parameters",
176180
"type": "boolean",
177181
"default": true
178182
},
179183
"show_docstring_raises": {
180184
"title": "Whether to display the \"Raises\" section in the object's docstring.",
181-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
185+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_raises",
182186
"type": "boolean",
183187
"default": true
184188
},
185189
"show_docstring_receives": {
186190
"title": "Whether to display the \"Receives\" section in the object's docstring.",
187-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
191+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_receives",
188192
"type": "boolean",
189193
"default": true
190194
},
191195
"show_docstring_returns": {
192196
"title": "Whether to display the \"Returns\" section in the object's docstring.",
193-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
197+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_returns",
194198
"type": "boolean",
195199
"default": true
196200
},
197201
"show_docstring_warns": {
198202
"title": "Whether to display the \"Warns\" section in the object's docstring.",
199-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
203+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_warns",
200204
"type": "boolean",
201205
"default": true
202206
},
203207
"show_docstring_yields": {
204208
"title": "Whether to display the \"Yields\" section in the object's docstring.",
205-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
209+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_yields",
206210
"type": "boolean",
207211
"default": true
208212
},
209213
"show_source": {
210214
"title": "Show the source code of this object.",
211-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
215+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/general/#show_source",
212216
"type": "boolean",
213217
"default": true
214218
},
215219
"show_bases": {
216220
"title": "Show the base classes of a class.",
217-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
221+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/general/#show_bases",
218222
"type": "boolean",
219223
"default": true
220224
},
221225
"show_submodules": {
222226
"title": "When rendering a module, show its submodules recursively.",
223-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
227+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#show_submodules",
224228
"type": "boolean",
225229
"default": false
226230
},
227231
"group_by_category": {
228232
"title": "Group the object's children by categories: attributes, classes, functions, and modules.",
229-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
233+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#group_by_category",
230234
"type": "boolean",
231235
"default": true
232236
},
233237
"heading_level": {
234238
"title": "The initial heading level to use.",
235-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
239+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/headings/#heading_level",
236240
"type": "integer",
237241
"default": 2
238242
},
239243
"members_order": {
240244
"title": "The members ordering to use.",
241-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
242-
"enum": ["alphabetical", "source"],
245+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#members_order",
246+
"enum": [
247+
"alphabetical",
248+
"source"
249+
],
243250
"default": "alphabetical"
244251
},
245252
"docstring_section_style": {
246253
"title": "The style used to render docstring sections.",
247-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
248-
"enum": ["list", "spacy", "table"],
254+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_section_style",
255+
"enum": [
256+
"list",
257+
"spacy",
258+
"table"
259+
],
249260
"default": "table"
250261
},
251262
"members": {
252263
"title": "An explicit list of members to render.",
253-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
264+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#members",
254265
"type": [
255266
"boolean",
256267
"array"
@@ -259,22 +270,27 @@
259270
},
260271
"filters": {
261272
"title": "A list of filters applied to filter objects based on their name. A filter starting with `!` will exclude matching objects instead of including them. The `members` option takes precedence over `filters` (filters will still be applied recursively to lower members in the hierarchy).",
262-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
273+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/members/#filters",
263274
"type": "array",
264-
"default": ["!^_[^_]"]
275+
"default": [
276+
"!^_[^_]"
277+
]
265278
},
266279
"annotations_path": {
267280
"title": "The verbosity for annotations path.",
268-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
269-
"enum": ["brief", "source"],
281+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/signatures/#annotations_path",
282+
"enum": [
283+
"brief",
284+
"source"
285+
],
270286
"default": "brief"
271287
},
272288
"preload_modules": {
273289
"title": "Pre-load modules. It permits to resolve aliases pointing to these modules (packages), and therefore render members of an object that are external to the given object (originating from another package).",
274-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
290+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/configuration/general/#preload_modules",
275291
"type": "array",
276292
"items": {
277-
"type":"string"
293+
"type": "string"
278294
}
279295
}
280296
},
@@ -285,4 +301,4 @@
285301
}
286302
},
287303
"additionalProperties": false
288-
}
304+
}

0 commit comments

Comments
 (0)