One sentence README and a readthedocs config.

Author: Julian

.readthedocs.yml

@@ -0,0 +1,15 @@
+version: 2
+
+sphinx:
+  builder: dirhtml
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+formats: all
+
+python:
+  version: "3.8"
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

README.rst

@@ -4,6 +4,8 @@
 
 |PyPI| |Pythons| |CI| |ReadTheDocs|
 
+JSON support files from the `JSON Schema Specifications <https://json-schema.org/specification.html>`_ (metaschemas, vocabularies, etc.), packaged for runtime access from Python.
+
 .. |PyPI| image:: https://img.shields.io/pypi/v/jsonschema-specifications.svg
   :alt: PyPI version
   :target: https://pypi.org/project/jsonschema-specifications/

docs/conf.py

@@ -52,6 +52,7 @@ def entire_domain(host):
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
+    "referencing": ("https://referencing.readthedocs.io/en/latest/", None),
 }
 
 # -- sphinxcontrib-spelling --

docs/index.rst

@@ -1,5 +1,6 @@
 .. include:: ../README.rst
 
+Resources are exposed via a `referencing.Registry`.
 
 Contents
 --------

docs/requirements.txt

@@ -6,6 +6,8 @@
 #
 alabaster==0.7.12
     # via sphinx
+attrs==22.2.0
+    # via referencing
 babel==2.11.0
     # via sphinx
 beautifulsoup4==4.11.1
@@ -19,7 +21,9 @@ docutils==0.19
 furo==2022.12.7
     # via -r docs/requirements.in
 idna==3.4
-    # via requests
+    # via
+    #   requests
+    #   yarl
 imagesize==1.4.1
     # via sphinx
 jinja2==3.1.2
@@ -28,6 +32,8 @@ file:.#egg=jsonschema_specifications
     # via -r docs/requirements.in
 markupsafe==2.1.1
     # via jinja2
+multidict==6.0.4
+    # via yarl
 packaging==22.0
     # via sphinx
 pyenchant==3.2.2
@@ -39,8 +45,12 @@ pygments==2.13.0
     #   sphinx
 pygments-github-lexers==0.0.5
     # via -r docs/requirements.in
+pyrsistent==0.19.2
+    # via referencing
 pytz==2022.7
     # via babel
+referencing==0.8.8
+    # via jsonschema-specifications
 requests==2.28.1
     # via sphinx
 snowballstemmer==2.2.0
@@ -77,3 +87,5 @@ sphinxext-opengraph==0.7.4
     # via -r docs/requirements.in
 urllib3==1.26.13
     # via requests
+yarl==1.8.2
+    # via referencing

docs/spelling-wordlist.txt

@@ -0,0 +1,2 @@
+metaschemas
+runtime