Initial docgen action

Author: yaswant

.github/workflows/docs.yaml

@@ -0,0 +1,63 @@
+---
+name: Docs
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - main
+      - 'releases/**'
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - 'mule/docs/**'
+      - '.github/workflows/docs.yaml'
+  workflow_dispatch:
+
+permissions: read-all
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: uv sync && uv pip install ./mule
+      - name: Build docs
+        run: uv run make clean html
+        working-directory: ./mule/docs
+    #   - id: permissions
+    #     name: Set permissions
+    #     run: |
+    #       chmod -c -R +rX "./doc/_build/html/"
+      - name: Upload artifacts
+        uses: actions/upload-pages-artifact@v4
+        with:
+          name: github-pages
+          path: ./mule/docs/_build/html
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+  # Deploy job
+  deploy:
+    if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
+    # Add a dependency to the build job
+    needs: build
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.python-version

@@ -0,0 +1 @@
+3.12.9

mule/docs/source/conf.py

@@ -46,7 +46,7 @@
 
 # General information about the project.
 project = "Mule"
-copyright = "2022, UM Systems Team"
+copyright = "2025, Met Office"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

mule/pyproject.toml

@@ -1,4 +1,4 @@
 # pyproject.toml
 [build-system]
 requires = ["setuptools >= 42.0.0", "numpy"]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta"

mule/setup.py

@@ -51,7 +51,7 @@ def run(self):
     version="2024.11.1",
     description="Unified Model Fields File interface",
     author="UM Systems Team",
-    url="https://code.metoffice.gov.uk/trac/um",
+    url="https://github.com/metoffice/mule",
     cmdclass={"clean": CleanCommand},
     package_dir={"": "lib"},
     packages=[

pyproject.toml

@@ -3,9 +3,19 @@ name = "mule"
 version = "2025.10.1"
 description = "API for interacting with UM output files"
 readme = "README.md"
-requires-python = ">=3.12.9"
+requires-python = ">=3.11"
 dependencies = [
     "cpplint == 2.0.2",
-    "ruff==0.12.1",
-    "shellcheck-py==0.10.0.1",
+    "ruff == 0.12.1",
+    "shellcheck-py == 0.10.0.1",
+    "sphinx == 8.2.3",
+    "sphinx-lint == 1.0.0",
+    "pydata-sphinx-theme == 0.16.1",
+    "sphinx-design == 0.6.1",
+    "sphinx-copybutton == 0.5.2",
+    "sphinx-lint == 1.0.0",
+    "sphinx-sitemap == 2.8.0",
+    "sphinxcontrib-svg2pdfconverter == 1.3.0",
+    "numpy == 2.3.3",
+    "six == 1.17.0",
 ]