Merge pull request #10 from OpenDataServices/2024-09-27

docs: Switch to ODSC theme & config

Author: James (ODSC)

.readthedocs.yaml

@@ -7,7 +7,7 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
     python: "3.9"
 
@@ -17,6 +17,9 @@ sphinx:
 
 # We recommend specifying your dependencies to enable reproducible builds:
 # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+python:
+  install:
+  - method: pip
+    path: .
+    extra_requirements:
+      - dev

docs/conf.py

@@ -1,3 +1,5 @@
 project = "LibCoveWeb2"
 
 master_doc = "index"
+
+html_theme = "odsc_default_sphinx_theme"

libcoveweb2/templatetags/cove_tags.py

@@ -15,15 +15,15 @@ def cove_modal_list(**kw):
 @register.inclusion_tag("modal_errors.html")
 def cove_modal_errors(**context):
     if hasattr(settings, "VALIDATION_ERROR_LOCATIONS_LENGTH"):
-        context[
-            "validation_error_locations_length"
-        ] = settings.VALIDATION_ERROR_LOCATIONS_LENGTH
+        context["validation_error_locations_length"] = (
+            settings.VALIDATION_ERROR_LOCATIONS_LENGTH
+        )
     else:
         context["validation_error_locations_length"] = 1000
     if hasattr(settings, "VALIDATION_ERROR_LOCATIONS_SAMPLE"):
-        context[
-            "validation_error_locations_sample"
-        ] = settings.VALIDATION_ERROR_LOCATIONS_SAMPLE
+        context["validation_error_locations_sample"] = (
+            settings.VALIDATION_ERROR_LOCATIONS_SAMPLE
+        )
     return context
 
 

setup.py

@@ -31,6 +31,13 @@
         "celery[redis]",
     ],
     extras_require={
-        "dev": ["black", "isort", "flake8", "mypy"],
+        "dev": [
+            "black",
+            "isort",
+            "flake8",
+            "mypy",
+            "sphinx",
+            "odsc-default-sphinx-theme",
+        ],
     },
 )