.readthedocs.yaml & specify theme

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: requirements_docs.txt
+

docs/conf.py

@@ -3,10 +3,12 @@
 
 master_doc = 'index'
 
-extensions = ['sphinxcontrib.jsonschema']
+extensions = ['sphinxcontrib.jsonschema', 'sphinx_rtd_theme']
 
 html_extra_path = [
     'example_components.json',
     'example_schema.json',
     'example_schema_with_external_refs.json'
 ]
+
+html_theme = "sphinx_rtd_theme"

requirements_docs.in

@@ -0,0 +1,3 @@
+# After compiling, this will make an absolute path
+# You'll have to edit it back to a relative one by hand
+-e .[test]

requirements_docs.txt

@@ -0,0 +1,111 @@
+#
+# This file is autogenerated by pip-compile with Python 3.9
+# by the following command:
+#
+#    pip-compile requirements_dev.in
+#
+-e . 
+    # via -r requirements_dev.in
+alabaster==0.7.13
+    # via sphinx
+babel==2.12.1
+    # via sphinx
+certifi==2023.7.22
+    # via requests
+charset-normalizer==3.2.0
+    # via requests
+docutils==0.18.1
+    # via
+    #   myst-parser
+    #   sphinx
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-opendataservices-jsonschema
+exceptiongroup==1.1.3
+    # via pytest
+flake8==5.0.4
+    # via sphinxcontrib-opendataservices-jsonschema
+idna==3.4
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+importlib-metadata==6.8.0
+    # via sphinx
+iniconfig==2.0.0
+    # via pytest
+jinja2==3.1.2
+    # via
+    #   myst-parser
+    #   sphinx
+jsonpointer==2.4
+    # via sphinxcontrib-opendataservices-jsonschema
+jsonref==1.1.0
+    # via sphinxcontrib-opendataservices-jsonschema
+lxml==4.9.3
+    # via sphinxcontrib-opendataservices-jsonschema
+markdown-it-py==3.0.0
+    # via
+    #   mdit-py-plugins
+    #   myst-parser
+markupsafe==2.1.3
+    # via jinja2
+mccabe==0.7.0
+    # via flake8
+mdit-py-plugins==0.4.0
+    # via myst-parser
+mdurl==0.1.2
+    # via markdown-it-py
+myst-parser==2.0.0
+    # via sphinxcontrib-opendataservices-jsonschema
+packaging==23.1
+    # via
+    #   pytest
+    #   sphinx
+pluggy==1.3.0
+    # via pytest
+pycodestyle==2.9.1
+    # via flake8
+pyflakes==2.5.0
+    # via flake8
+pygments==2.16.1
+    # via sphinx
+pytest==7.4.2
+    # via sphinxcontrib-opendataservices-jsonschema
+pyyaml==6.0.1
+    # via myst-parser
+requests==2.31.0
+    # via sphinx
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==7.2.6
+    # via
+    #   myst-parser
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-applehelp
+    #   sphinxcontrib-devhelp
+    #   sphinxcontrib-htmlhelp
+    #   sphinxcontrib-jquery
+    #   sphinxcontrib-opendataservices-jsonschema
+    #   sphinxcontrib-qthelp
+    #   sphinxcontrib-serializinghtml
+sphinx-rtd-theme==1.3.0
+    # via sphinxcontrib-opendataservices-jsonschema
+sphinxcontrib-applehelp==1.0.7
+    # via sphinx
+sphinxcontrib-devhelp==1.0.5
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.4
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.6
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.9
+    # via sphinx
+tomli==2.0.1
+    # via pytest
+urllib3==2.0.4
+    # via requests
+zipp==3.16.2
+    # via importlib-metadata

setup.py

@@ -44,6 +44,8 @@
             'flake8<6',
             'lxml',
             'pytest',
+            'sphinx',
+            'sphinx-rtd-theme',
         ],
     },
     namespace_packages=['sphinxcontrib'],