Fix documentation build

.github/workflows/docs-build-deploy.yml

@@ -3,19 +3,26 @@ on:
   push:
     branches:
       - main
+  pull_request:
+    branches:
+      - main
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
     - name: Install cats with documentation helpers
       run: python3 -m pip install '.[docs]'
     - name: Build sphinx docs
       run: make -C docs html
     - name: Deploy sphinx docs
+      if: github.ref == 'refs/heads/main'
       run: |
         git config user.name 'github-action'
         git config user.email 'github-action'

cats/__init__.py

@@ -33,7 +33,7 @@ def parse_arguments():
     """
     description_text = f"""
     Climate-Aware Task Scheduler (version {__version__})
-    --------------------------------------------------------------------------
+
     The Climate-Aware Task Scheduler (cats) command line program helps you run
     your calculations in a way that minimises their impact on the climate by
     delaying computation until a time when the ammount of CO2 produced to

pyproject.toml

@@ -41,7 +41,7 @@
   [project.optional-dependencies]
     test = ["pytest", "numpy>=1.5.0", "pytest-subprocess==1.5.0", "pytest-cov"]
     types = ["mypy", "types-PyYAML", "types-redis", "types-requests", "types-ujson"]
-    docs = ["sphinx", "sphinx-argparse", "ghp-import", "renku-sphinx-theme", "sphinx_copybutton"]
+    docs = ["sphinx==6.*", "sphinx-argparse", "ghp-import", "renku-sphinx-theme", "sphinx_copybutton"]
 
   [project.urls]
     Home = "https://github.com/GreenScheduler/cats"