diff options
-rw-r--r-- | docs/api/index.rst | 7 | ||||
-rw-r--r-- | docs/api/jsonschema/exceptions/index.rst | 6 | ||||
-rw-r--r-- | docs/api/jsonschema/index.rst | 20 | ||||
-rw-r--r-- | docs/api/jsonschema/protocols/index.rst | 6 | ||||
-rw-r--r-- | docs/api/jsonschema/validators/index.rst | 6 | ||||
-rw-r--r-- | docs/conf.py | 31 | ||||
-rw-r--r-- | docs/validate.rst | 4 |
7 files changed, 51 insertions, 29 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 0000000..0dc33a7 --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,7 @@ +API Reference +============= + +.. toctree:: + :titlesonly: + + /api/jsonschema/index diff --git a/docs/api/jsonschema/exceptions/index.rst b/docs/api/jsonschema/exceptions/index.rst new file mode 100644 index 0000000..8fb1f4f --- /dev/null +++ b/docs/api/jsonschema/exceptions/index.rst @@ -0,0 +1,6 @@ +:py:mod:`jsonschema.exceptions` +=============================== + +.. automodule:: jsonschema.exceptions + :members: + :undoc-members: diff --git a/docs/api/jsonschema/index.rst b/docs/api/jsonschema/index.rst new file mode 100644 index 0000000..b71d7c3 --- /dev/null +++ b/docs/api/jsonschema/index.rst @@ -0,0 +1,20 @@ +:py:mod:`jsonschema` +==================== + +Submodules +---------- + +.. toctree:: + :titlesonly: + + /api/jsonschema/exceptions/index + /api/jsonschema/protocols/index + /api/jsonschema/validators/index + +Package summary +--------------- + +.. automodule:: jsonschema + :members: + :imported-members: + diff --git a/docs/api/jsonschema/protocols/index.rst b/docs/api/jsonschema/protocols/index.rst new file mode 100644 index 0000000..6cf26b7 --- /dev/null +++ b/docs/api/jsonschema/protocols/index.rst @@ -0,0 +1,6 @@ +:py:mod:`jsonschema.protocols` +============================== + +.. automodule:: jsonschema.protocols + :members: + :undoc-members:
\ No newline at end of file diff --git a/docs/api/jsonschema/validators/index.rst b/docs/api/jsonschema/validators/index.rst new file mode 100644 index 0000000..0d34f8d --- /dev/null +++ b/docs/api/jsonschema/validators/index.rst @@ -0,0 +1,6 @@ +:py:mod:`jsonschema.validators` +=============================== + +.. automodule:: jsonschema.validators + :members: + :undoc-members:
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 0e4bc6c..595cdf6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,15 +36,15 @@ extensions = [ "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.viewcode", - - "autoapi.extension", - "sphinx_autodoc_typehints", "sphinx_copybutton", "sphinx_json_schema_spec", "sphinxcontrib.spelling", "sphinxext.opengraph", ] +# Add typing annotations to signatures +autodoc_typehints = "signature" + cache_path = "_cache" # Add any paths that contain templates here, relative to this directory. @@ -159,28 +159,3 @@ autosectionlabel_prefix_document = True # -- Options for sphinxcontrib-spelling ----------------------------------- spelling_word_list_filename = "spelling-wordlist.txt" - -# -- Options for autoapi ---------------------------------------------------- - -suppress_warnings = [ - "autoapi.python_import_resolution", - "autoapi.toc_reference", - "epub.duplicated_toc_entry", -] -autoapi_root = "api" -autoapi_ignore = [ - "*/_[a-z]*.py", - "*/__main__.py", - "*/benchmarks/*", - "*/cli.py", - "*/tests/*", -] -autoapi_options = [ - "members", - "undoc-members", - "show-module-summary", - "imported-members", -] - -autoapi_type = "python" -autoapi_dirs = [PACKAGE_SRC] diff --git a/docs/validate.rst b/docs/validate.rst index 3d04a9a..704003d 100644 --- a/docs/validate.rst +++ b/docs/validate.rst @@ -58,6 +58,7 @@ versions. .. autoclass:: TypeChecker :members: + :noindex: .. autoexception:: jsonschema.exceptions.UndefinedTypeCheck :noindex: @@ -88,7 +89,7 @@ given how common validating these types are. If you *do* want the generality, or just want to add a few specific additional types as being acceptable for a validator object, then you should update an -existing `TypeChecker` or create a new one. You may then create a new +existing `jsonschema.TypeChecker` or create a new one. You may then create a new `Validator` via `jsonschema.validators.extend`. .. testcode:: @@ -252,6 +253,7 @@ The supported mechanism for ensuring these dependencies are present is again as .. autoclass:: FormatChecker :members: + :noindex: :exclude-members: cls_checks .. attribute:: checkers |