File tree Expand file tree Collapse file tree 7 files changed +51
-29
lines changed Expand file tree Collapse file tree 7 files changed +51
-29
lines changed Original file line number Diff line number Diff line change
1
+ API Reference
2
+ =============
3
+
4
+ .. toctree ::
5
+ :titlesonly:
6
+
7
+ /api/jsonschema/index
Original file line number Diff line number Diff line change
1
+ :py:mod: `jsonschema.exceptions `
2
+ ===============================
3
+
4
+ .. automodule :: jsonschema.exceptions
5
+ :members:
6
+ :undoc-members:
Original file line number Diff line number Diff line change
1
+ :py:mod: `jsonschema `
2
+ ====================
3
+
4
+ Submodules
5
+ ----------
6
+
7
+ .. toctree ::
8
+ :titlesonly:
9
+
10
+ /api/jsonschema/exceptions/index
11
+ /api/jsonschema/protocols/index
12
+ /api/jsonschema/validators/index
13
+
14
+ Package summary
15
+ ---------------
16
+
17
+ .. automodule :: jsonschema
18
+ :members:
19
+ :imported-members:
20
+
Original file line number Diff line number Diff line change
1
+ :py:mod: `jsonschema.protocols `
2
+ ==============================
3
+
4
+ .. automodule :: jsonschema.protocols
5
+ :members:
6
+ :undoc-members:
Original file line number Diff line number Diff line change
1
+ :py:mod: `jsonschema.validators `
2
+ ===============================
3
+
4
+ .. automodule :: jsonschema.validators
5
+ :members:
6
+ :undoc-members:
Original file line number Diff line number Diff line change 36
36
"sphinx.ext.intersphinx" ,
37
37
"sphinx.ext.napoleon" ,
38
38
"sphinx.ext.viewcode" ,
39
-
40
- "autoapi.extension" ,
41
- "sphinx_autodoc_typehints" ,
42
39
"sphinx_copybutton" ,
43
40
"sphinx_json_schema_spec" ,
44
41
"sphinxcontrib.spelling" ,
45
42
"sphinxext.opengraph" ,
46
43
]
47
44
45
+ # Add typing annotations to signatures
46
+ autodoc_typehints = "signature"
47
+
48
48
cache_path = "_cache"
49
49
50
50
# Add any paths that contain templates here, relative to this directory.
@@ -159,28 +159,3 @@ def entire_domain(host):
159
159
# -- Options for sphinxcontrib-spelling -----------------------------------
160
160
161
161
spelling_word_list_filename = "spelling-wordlist.txt"
162
-
163
- # -- Options for autoapi ----------------------------------------------------
164
-
165
- suppress_warnings = [
166
- "autoapi.python_import_resolution" ,
167
- "autoapi.toc_reference" ,
168
- "epub.duplicated_toc_entry" ,
169
- ]
170
- autoapi_root = "api"
171
- autoapi_ignore = [
172
- "*/_[a-z]*.py" ,
173
- "*/__main__.py" ,
174
- "*/benchmarks/*" ,
175
- "*/cli.py" ,
176
- "*/tests/*" ,
177
- ]
178
- autoapi_options = [
179
- "members" ,
180
- "undoc-members" ,
181
- "show-module-summary" ,
182
- "imported-members" ,
183
- ]
184
-
185
- autoapi_type = "python"
186
- autoapi_dirs = [PACKAGE_SRC ]
Original file line number Diff line number Diff line change @@ -58,6 +58,7 @@ versions.
58
58
59
59
.. autoclass :: TypeChecker
60
60
:members:
61
+ :noindex:
61
62
62
63
.. autoexception :: jsonschema.exceptions.UndefinedTypeCheck
63
64
:noindex:
@@ -88,7 +89,7 @@ given how common validating these types are.
88
89
89
90
If you *do * want the generality, or just want to add a few specific additional
90
91
types as being acceptable for a validator object, then you should update an
91
- existing `TypeChecker ` or create a new one. You may then create a new
92
+ existing `jsonschema. TypeChecker ` or create a new one. You may then create a new
92
93
`Validator ` via `jsonschema.validators.extend `.
93
94
94
95
.. testcode ::
@@ -252,6 +253,7 @@ The supported mechanism for ensuring these dependencies are present is again as
252
253
253
254
.. autoclass :: FormatChecker
254
255
:members:
256
+ :noindex:
255
257
:exclude-members: cls_checks
256
258
257
259
.. attribute :: checkers
You can’t perform that action at this time.
0 commit comments