Skip to content

Commit 96e231a

Browse files
pawamoypawamoy
committed
chore: Fix JSON schema
1 parent 5b821e3 commit 96e231a

File tree

1 file changed

+185
-150
lines changed

1 file changed

+185
-150
lines changed

‎docs/schema.json

Lines changed: 185 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -7,161 +7,196 @@
77
"markdownDescription": "https://mkdocstrings.github.io/python/",
88
"type": "object",
99
"properties": {
10-
"custom_templates": {
11-
"title": "The path to a directory containing custom templates. The path is relative to the current working directory.",
12-
"markdownDescription": "https://mkdocstrings.github.io/theming/",
13-
"type": "string",
14-
"default": null,
15-
"format": "path"
16-
},
17-
"docstring_style": {
18-
"title": "The docstring style to use when parsing docstrings.",
19-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
20-
"enum": ["google", "numpy", "sphinx"],
21-
"default": "google"
22-
},
23-
"docstring_options": {
24-
"title": "The options for the docstring parser.",
25-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
26-
"default": null,
10+
"import": {
11+
"title": "Inventories to import.",
12+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#global-only-options",
13+
"type": "array",
2714
"items": {
28-
"$ref": "https://raw.githubusercontent.com/mkdocstrings/griffe/master/docs/schema-docstrings-options.json"
15+
"oneOf": [
16+
{
17+
"type": "string"
18+
},
19+
{
20+
"type": "object",
21+
"properties": {
22+
"url": {
23+
"title": "URL of the inventory file.",
24+
"type": "string"
25+
},
26+
"base_url": {
27+
"title": "Base URL used to build references URLs.",
28+
"type": "string"
29+
}
30+
}
31+
}
32+
]
2933
}
3034
},
31-
"show_root_heading": {
32-
"title": "Show the heading of the object at the root of the documentation tree.",
33-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
34-
"type": "boolean",
35-
"default": false
36-
},
37-
"show_root_toc_entry": {
38-
"title": "If the root heading is not shown, at least add a ToC entry for it.",
39-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
40-
"type": "boolean",
41-
"default": true
42-
},
43-
"show_root_full_path": {
44-
"title": "Show the full Python path for the root object heading.",
45-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
46-
"type": "boolean",
47-
"default": true
48-
},
49-
"show_root_members_full_path": {
50-
"title": "Show the full Python path of the root members.",
51-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
52-
"type": "boolean",
53-
"default": false
54-
},
55-
"show_object_full_path": {
56-
"title": "Show the full Python path of every object.",
57-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
58-
"type": "boolean",
59-
"default": false
60-
},
61-
"show_category_heading": {
62-
"title": "When grouped by categories, show a heading for each category.",
63-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
64-
"type": "boolean",
65-
"default": false
66-
},
67-
"show_if_no_docstring": {
68-
"title": "Show the object heading even if it has no docstring or children with docstrings.",
69-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
70-
"type": "boolean",
71-
"default": false
72-
},
73-
"show_signature": {
74-
"title": "Show methods and functions signatures.",
75-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
76-
"type": "boolean",
77-
"default": true
78-
},
79-
"show_signature_annotations": {
80-
"title": "Show the type annotations in methods and functions signatures.",
81-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
82-
"type": "boolean",
83-
"default": false
84-
},
85-
"separate_signature": {
86-
"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.",
87-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
88-
"type": "boolean",
89-
"default": false
90-
},
91-
"line_length": {
92-
"title": "Maximum line length when formatting code/signatures.",
93-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
94-
"type": "integer",
95-
"default": 60
96-
},
97-
"merge_init_into_class": {
98-
"title": "Whether to merge the `__init__` method into the class' signature and docstring.",
99-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
100-
"type": "boolean",
101-
"default": false
102-
},
103-
"show_source": {
104-
"title": "Show the source code of this object..",
105-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
106-
"type": "boolean",
107-
"default": true
108-
},
109-
"show_bases": {
110-
"title": "Show the base classes of a class.",
111-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
112-
"type": "boolean",
113-
"default": true
114-
},
115-
"show_submodules": {
116-
"title": "When rendering a module, show its submodules recursively.",
117-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
118-
"type": "boolean",
119-
"default": false
120-
},
121-
"group_by_category": {
122-
"title": "Group the object's children by categories: attributes, classes, functions, and modules.",
123-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
124-
"type": "boolean",
125-
"default": true
126-
},
127-
"heading_level": {
128-
"title": "The initial heading level to use.",
129-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
130-
"type": "integer",
131-
"default": 2
132-
},
133-
"members_order": {
134-
"title": "The members ordering to use.",
135-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
136-
"enum": ["alphabetical", "source"],
137-
"default": "alphabetical"
138-
},
139-
"docstring_section_style": {
140-
"title": "The style used to render docstring sections.",
141-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
142-
"enum": ["list", "spacy", "table"],
143-
"default": "table"
144-
},
145-
"members": {
146-
"title": "An explicit list of members to render.",
147-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
148-
"type": [
149-
"boolean",
150-
"array"
151-
],
152-
"default": null
153-
},
154-
"filters": {
155-
"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).",
156-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
35+
"paths": {
36+
"title": "Local absolute/relative paths (relative to mkdocs.yml) to search packages into.",
37+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#global-only-options",
15738
"type": "array",
158-
"default": ["!^_[^_]"]
39+
"items": {
40+
"type": "string",
41+
"format": "path"
42+
}
15943
},
160-
"annotations_path": {
161-
"title": "The verbosity for annotations path.",
162-
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
163-
"enum": ["brief", "source"],
164-
"default": "brief"
44+
"options": {
45+
"title": "Options for collecting and rendering objects.",
46+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
47+
"type": "object",
48+
"properties": {
49+
"docstring_style": {
50+
"title": "The docstring style to use when parsing docstrings.",
51+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
52+
"enum": ["google", "numpy", "sphinx"],
53+
"default": "google"
54+
},
55+
"docstring_options": {
56+
"title": "The options for the docstring parser.",
57+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
58+
"default": null,
59+
"items": {
60+
"$ref": "https://raw.githubusercontent.com/mkdocstrings/griffe/master/docs/schema-docstrings-options.json"
61+
}
62+
},
63+
"show_root_heading": {
64+
"title": "Show the heading of the object at the root of the documentation tree.",
65+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
66+
"type": "boolean",
67+
"default": false
68+
},
69+
"show_root_toc_entry": {
70+
"title": "If the root heading is not shown, at least add a ToC entry for it.",
71+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
72+
"type": "boolean",
73+
"default": true
74+
},
75+
"show_root_full_path": {
76+
"title": "Show the full Python path for the root object heading.",
77+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
78+
"type": "boolean",
79+
"default": true
80+
},
81+
"show_root_members_full_path": {
82+
"title": "Show the full Python path of the root members.",
83+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
84+
"type": "boolean",
85+
"default": false
86+
},
87+
"show_object_full_path": {
88+
"title": "Show the full Python path of every object.",
89+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
90+
"type": "boolean",
91+
"default": false
92+
},
93+
"show_category_heading": {
94+
"title": "When grouped by categories, show a heading for each category.",
95+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
96+
"type": "boolean",
97+
"default": false
98+
},
99+
"show_if_no_docstring": {
100+
"title": "Show the object heading even if it has no docstring or children with docstrings.",
101+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
102+
"type": "boolean",
103+
"default": false
104+
},
105+
"show_signature": {
106+
"title": "Show methods and functions signatures.",
107+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
108+
"type": "boolean",
109+
"default": true
110+
},
111+
"show_signature_annotations": {
112+
"title": "Show the type annotations in methods and functions signatures.",
113+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
114+
"type": "boolean",
115+
"default": false
116+
},
117+
"separate_signature": {
118+
"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.",
119+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
120+
"type": "boolean",
121+
"default": false
122+
},
123+
"line_length": {
124+
"title": "Maximum line length when formatting code/signatures.",
125+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
126+
"type": "integer",
127+
"default": 60
128+
},
129+
"merge_init_into_class": {
130+
"title": "Whether to merge the `__init__` method into the class' signature and docstring.",
131+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
132+
"type": "boolean",
133+
"default": false
134+
},
135+
"show_source": {
136+
"title": "Show the source code of this object..",
137+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
138+
"type": "boolean",
139+
"default": true
140+
},
141+
"show_bases": {
142+
"title": "Show the base classes of a class.",
143+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
144+
"type": "boolean",
145+
"default": true
146+
},
147+
"show_submodules": {
148+
"title": "When rendering a module, show its submodules recursively.",
149+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
150+
"type": "boolean",
151+
"default": false
152+
},
153+
"group_by_category": {
154+
"title": "Group the object's children by categories: attributes, classes, functions, and modules.",
155+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
156+
"type": "boolean",
157+
"default": true
158+
},
159+
"heading_level": {
160+
"title": "The initial heading level to use.",
161+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
162+
"type": "integer",
163+
"default": 2
164+
},
165+
"members_order": {
166+
"title": "The members ordering to use.",
167+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
168+
"enum": ["alphabetical", "source"],
169+
"default": "alphabetical"
170+
},
171+
"docstring_section_style": {
172+
"title": "The style used to render docstring sections.",
173+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
174+
"enum": ["list", "spacy", "table"],
175+
"default": "table"
176+
},
177+
"members": {
178+
"title": "An explicit list of members to render.",
179+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
180+
"type": [
181+
"boolean",
182+
"array"
183+
],
184+
"default": null
185+
},
186+
"filters": {
187+
"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).",
188+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
189+
"type": "array",
190+
"default": ["!^_[^_]"]
191+
},
192+
"annotations_path": {
193+
"title": "The verbosity for annotations path.",
194+
"markdownDescription": "https://mkdocstrings.github.io/python/usage/#globallocal-options",
195+
"enum": ["brief", "source"],
196+
"default": "brief"
197+
}
198+
},
199+
"additionalProperties": false
165200
}
166201
},
167202
"additionalProperties": false

0 commit comments

Comments
 (0)