Merge pull request #3436 from rbtcollins/dev-docs-toc

Dev-docs-toc

Author: rbtcollins

.github/workflows/deploy-docs.yaml

@@ -6,6 +6,12 @@ on:
       - stable
       - master
 
+# Builds all docs for both stable and master branches.
+# In the gh-pages branch, we place:
+# stable user-guide at /
+# master user-guide at /devel
+# master dev-guide at /dev-guide
+
 jobs:
   doc:
     name: Documentation
@@ -21,13 +27,22 @@ jobs:
           echo "`pwd`/mdbook" >> $GITHUB_PATH
       - name: Build book
         run: |
+          # Build for stable
           git checkout stable
-          cd doc
+          # Support both old and new directory structure during the transition
+          cd doc/user-guide || cd doc
           mdbook build
           mv book ${{ runner.temp }}
+          # Build for master
+          cd $(git rev-parse --show-toplevel)
           git checkout master
+          cd doc/user-guide
           mdbook build
           mv book ${{ runner.temp }}/book/devel
+          # Build dev-guide for master
+          cd ../dev-guide
+          mdbook build
+          mv book ${{ runner.temp }}/book/dev-guide
       - name: Deploy to GitHub
         run: |
           cd ${{ runner.temp }}/book

.github/workflows/test-docs.yaml

@@ -0,0 +1,31 @@
+name: Test build docs on PR
+
+on:
+  pull_request:
+    branches:
+      - "*"
+
+# Builds docs for both stable and master branches.
+# stable is placed in the root of the gh-pages branch, while master is placed at /devel
+
+jobs:
+  doc:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Install mdbook
+        run: |
+          mkdir mdbook
+          curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.6/mdbook-v0.4.6-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+          echo "`pwd`/mdbook" >> $GITHUB_PATH
+      - name: Build user-guide
+        run: |
+          cd doc/user-guide
+          mdbook build
+      - name: Build dev-guide
+        run: |
+          cd doc/dev-guide
+          mdbook build