Ensure REGISTRY shows up in the docs.

python-jsonschema · Mar 20, 2023 · aec21f5 · aec21f5
1 parent 25dc542
commit aec21f5
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,6 +1,8 @@
 import importlib.metadata
 import re
 
+HOMEPAGE = "https://github.com/python-jsonschema/jsonschema-specifications"
+
 project = "jsonschema-specifications"
 author = "Julian Berman"
 copyright = f"2022, {author}"
@@ -38,12 +40,19 @@ def entire_domain(host):
 
 linkcheck_ignore = [
     entire_domain("img.shields.io"),
-    "https://github.com/python-jsonschema/jsonschema/actions",
-    "https://github.com/python-jsonschema/jsonschema/workflows/CI/badge.svg",
+    f"{HOMEPAGE}/actions",
+    f"{HOMEPAGE}/workflows/CI/badge.svg",
 ]
 
 # = Extensions =
 
+# -- autodoc --
+
+autodoc_default_options = {
+    "members": True,
+    "member-order": "bysource",
+}
+
 # -- autosectionlabel --
 
 autosectionlabel_prefix_document = True

diff --git a/docs/spelling-wordlist.txt b/docs/spelling-wordlist.txt
@@ -1,2 +1,3 @@
 metaschemas
 runtime
+schemas
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
diff --git a/jsonschema_specifications/__init__.py b/jsonschema_specifications/__init__.py
@@ -1 +1,10 @@
-from jsonschema_specifications._core import REGISTRY  # noqa: F401
+from referencing import Registry as _Registry
+from referencing.jsonschema import SchemaRegistry as _SchemaRegistry
+
+from jsonschema_specifications._core import _schemas
+
+#: A `referencing.jsonschema.SchemaRegistry` containing all of the official
+#: meta-schemas and vocabularies.
+REGISTRY: _SchemaRegistry = (_schemas() @ _Registry()).crawl()
+
+__all__ = ["REGISTRY"]
diff --git a/jsonschema_specifications/_core.py b/jsonschema_specifications/_core.py
@@ -9,7 +9,7 @@
 except ImportError:
     from importlib_resources import files  # type: ignore
 
-from referencing import Registry, Resource
+from referencing import Resource
 
 
 def _schemas():
@@ -31,6 +31,3 @@ def _schemas():
             for path in children:
                 contents = json.loads(path.read_text())
                 yield Resource.from_contents(contents)
-
-
-REGISTRY: Registry = (_schemas() @ Registry()).crawl()