chore: Build API docs after mkdocs

Building mkdocs overwrites the entire folder, thereby replacing the typedocs.
Hence the typedocs need to be written afterwards

.github/workflows/main.yml

@@ -34,12 +34,7 @@ jobs:
       DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
       DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
 
-  typedocs-release:
-  # Release typedocs on version tag, but ignore pre-releases
-    if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, '-')
-    uses: ./.github/workflows/typedocs.yml
-
   mkdocs-release:
-  # Release mkdocs on version tag, but ignore pre-releases
+  # Release documentation on version tag, but ignore pre-releases
     if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, '-')
     uses: ./.github/workflows/mkdocs.yml

.github/workflows/mkdocs.yml

@@ -15,7 +15,7 @@ on:
 jobs:
   mkdocs-prep:
   # Runs the markdown linter to ensure we don't release faulty markdown.
-  # Also gets the correct major version, wether the job is triggered by a version tag
+  # Also gets the correct major version, whether the job is triggered by a version tag
   #   or a push to main to update the latest documentation.
     runs-on: ubuntu-latest
     outputs:
@@ -55,3 +55,24 @@ jobs:
       - run: |
           cd documentation && mike deploy --push --update-aliases \
             ${{ needs.mkdocs-prep.outputs.major }}.x latest
+  
+
+  typedocs:
+    # Build typedocs and publish them to the GH page.
+    # `mike deploy` overwrites the entire folder for a version so these need to be (re)built afterwards.
+    needs: [mkdocs-prep, mkdocs]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3.1.0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - run: npm ci --ignore-scripts
+      - name: Generate typedocs
+        run: npm run typedocs
+      - name: Deploy typedocs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+          destination_dir:  ${{ needs.mkdocs-prep.outputs.major }}.x/docs

.github/workflows/typedocs.yml

@@ -1,25 +0,0 @@
-name: Typedocs
-on:
-  workflow_call:
-
-jobs:
-  typedocs:
-  # Build typedocs and publish them to the GH page
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3.1.0
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '16.x'
-      - run: npm ci --ignore-scripts
-      - name: Generate typedocs
-        run: npm run typedocs
-      - name: Get tagged version
-        id: version
-        uses: battila7/get-version-action@v2
-      - name: Deploy typedocs
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs
-          destination_dir:  ${{ steps.version.outputs.major }}.x/docs