Documentation setup

.github/workflows/check_links.yml

@@ -0,0 +1,27 @@
+# =========== IMPORTANT!! READ THIS!! ============ #
+# This file is used to check links and can be copied to be used for documentation websites.
+
+# When you copy this file, make sure to check and modify the fields
+# that here are marked with `MODIFY`.
+# ============================================== #
+
+name: Check links
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check-links:
+    uses: access-nri/documentation-infra/.github/workflows/[email protected]
+    with:
+      repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
+      commit: ${{ github.event.pull_request.head.sha || github.sha }}
+      rtd_project: 'esmf-trace'  # MODIFY: change this to the Read the Docs project
+    #   readthedocs_yaml: # MODIFY: Uncomment to add .readthedocs.yaml path. If not included, '.readthedocs.yaml' is used.
+    #   lychee_config: '/path/to/lychee_config.toml' # MODIFY: Uncomment to add lychee config path. If not included, the one from the ACCESS-NRI/documentation-infra repo gets used.
+    # secrets: # MODIFY: Uncomment the lines below if the repo is private. You also need to create a secret named REPO_READ_TOKEN with a token that has repo read permissions.
+    #   repo_read_token: ${{ secrets.REPO_READ_TOKEN }}

.github/workflows/ci.yml

@@ -2,8 +2,14 @@ name: CI
 on:
     push:
         branches: [ "main" ]
+        paths-ignore:
+          - ".github/**"
+          - "documentation/**"
     pull_request:
         branches: [ "main" ]
+        paths-ignore:
+          - ".github/**"
+          - "documentation/**"
     workflow_dispatch:
     workflow_call:
 

.readthedocs.yaml

@@ -0,0 +1,31 @@
+# =========== IMPORTANT!! READ THIS!! ============ #
+# This file can be copied to be used for websites deployments with RTD.
+# When you copy this file, make sure to check and modify the fields
+# that here are marked with `MODIFY`.
+# ============================================== #
+
+
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# ReadtheDocs config version
+version: 2
+
+# Set the ReadtheDocs Docker image OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+  # jobs: # MODIFY: uncomment lines below to cancel the RTD build (e.g., for specific branches)
+    # post_checkout:
+    #   - exit 183
+
+# Build documentation with Mkdocs
+mkdocs:
+  configuration: documentation/mkdocs.yml # MODIFY: path to mkdocs.yml
+
+# Python requirements to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: documentation/requirements.txt # MODIFY: path to requirements.txt