♻️ Move documentation building command to pyproject.toml

.github/workflows/documentation.yaml → .github/workflows/build_documentation.yaml

@@ -18,16 +18,17 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
           python-version: 3.12
-      - name: Install dependencies
-        run: |
-          pip install -r requirements.txt
-      - name: Sphinx build
-        run: |
-          make html SPHINXOPTS="-W"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build documentation
+        run: hatch run docs:build
 
   check_links:
     name: Check links
@@ -39,17 +40,18 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
           python-version: 3.12
-      - name: Install dependencies
-        run: |
-          pip install -r requirements.txt
-      - name: Sphinx build
-        # Set warnings to be treated as errors
-        run: |
-          make html SPHINXOPTS="-W"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build documentation
+        run: hatch run docs:build
+
       - name: Link Checker
         uses: lycheeverse/[email protected]
         with:

pyproject.toml

@@ -66,6 +66,13 @@ dependencies = [
   "pydata-sphinx-theme>=0.15.0",
   "Sphinx>=7.3.0",
 ]
+pre-install-commands = ["pip install -r docs/requirements.txt"]
+
+[tool.hatch.envs.docs.scripts]
+build = [
+  # Treat warnings as errors
+  "make -C docs html SPHINXOPTS='-W'"
+]
 
 [tool.hatch.envs.lint]
 detached = true