summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniël van Noord <13665637+DanielNoord@users.noreply.github.com>2022-11-28 23:56:20 +0100
committerDaniël van Noord <13665637+DanielNoord@users.noreply.github.com>2022-11-28 23:56:20 +0100
commitbbf9ccff80c86abd7dad56c5ac29de4a4abe40ce (patch)
treeb0d8387abb44d8a7c1ac5576325a0b320eb81e83 /docs
parentcdf0c71bcc07966ff131bfca83a3131c7e41f202 (diff)
downloadjsonschema-bbf9ccff80c86abd7dad56c5ac29de4a4abe40ce.tar.gz
Use only ``autodoc`` to generate the API documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/api/index.rst7
-rw-r--r--docs/api/jsonschema/exceptions/index.rst6
-rw-r--r--docs/api/jsonschema/index.rst20
-rw-r--r--docs/api/jsonschema/protocols/index.rst6
-rw-r--r--docs/api/jsonschema/validators/index.rst6
-rw-r--r--docs/conf.py31
-rw-r--r--docs/validate.rst4
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