ci: add docs CI

.github/workflows/ci.yaml

@@ -6,14 +6,15 @@ on:
       - main
       - rel-*
     tags:
-      - v*
+      # Must not take the form vX.Y which is reserved for docs
+      - v*.*.*
   pull_request:
     branches:
       - main
       - rel-*
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  
+
   # Terminate all previous runs of the same workflow and branch/tag, except for main and release branches/tags
   cancel-in-progress: "${{ !(github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v') || startsWith(github.ref, 'refs/heads/rel-')) }}"
 
@@ -32,7 +33,7 @@ jobs:
           # shellcheck disable=SC2046
           nix-store -v --realize $( nix-instantiate default.nix )
         shell: bash
-    
+
   Lint-Style:
     name: Lint & check code style
     runs-on: ubuntu-latest
@@ -102,9 +103,9 @@ jobs:
         uses: ./.github/actions/setup-nix
         with:
           tools: tests withTools
-          # It seems like they are installing the same set of derivations, so we can assign them the same cache id. 
+          # It seems like they are installing the same set of derivations, so we can assign them the same cache id.
           # This would decrease the amount of caches dowloaded on merge cache step and will prevent disk space issues.
-          cache-id: common 
+          cache-id: common
 
       - name: Run spec tests
         if: always()

docs/.github/workflows/ci.yaml → .github/workflows/docs.yaml

@@ -1,41 +1,52 @@
-name: CI
+name: Documentation
 
 on:
   push:
     branches:
-    - main
-    - v*
+      - main
+      - rel-*
+    tags:
+      - v[0-9]+.[0-9]+
   pull_request:
     branches:
-    - main
-    - v*
+      - main
+      - rel-*
 
 jobs:
   build:
     name: Build docs
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: cachix/install-nix-action@v24
-    - run: nix-env -f default.nix -iA build
+    - name: Setup Nix Environment
+      uses: ./.github/actions/setup-nix
+      with:
+        tools: docs
+        cache-id: common
     - run: postgrest-docs-build
 
   spellcheck:
     name: Run spellcheck
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: cachix/install-nix-action@v24
-    - run: nix-env -f default.nix -iA spellcheck
+    - name: Setup Nix Environment
+      uses: ./.github/actions/setup-nix
+      with:
+        tools: docs
+        cache-id: common
     - run: postgrest-docs-spellcheck
 
   dictcheck:
     name: Run dictcheck
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: cachix/install-nix-action@v24
-      - run: nix-env -f default.nix -iA dictcheck
+      - name: Setup Nix Environment
+        uses: ./.github/actions/setup-nix
+        with:
+          tools: docs
+          cache-id: common
       - run: postgrest-docs-dictcheck
 
   linkcheck:
@@ -44,7 +55,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: cachix/install-nix-action@v24
-    - run: nix-env -f default.nix -iA linkcheck
+    - name: Setup Nix Environment
+      uses: ./.github/actions/setup-nix
+      with:
+        tools: docs
+        cache-id: common
     - run: postgrest-docs-linkcheck
-

docs/.readthedocs.yaml → .readthedocs.yaml

@@ -1,9 +1,9 @@
 version: 2
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/docs/conf.py
 python:
    install:
-   - requirements: requirements.txt
+   - requirements: docs/requirements.txt
 build:
   os: ubuntu-22.04
   tools: