Merge pull request #100 from ros-realtime/fix/docs-ci

Ensure gh-pages git history is fetched, add comments to workflow

Author: flynneva

.github/workflows/docs.yml

@@ -42,9 +42,11 @@ jobs:
             --config ros2_ws/src/reference_system/docs/doxybook2_config.json
       - name: build mkdocs site
         run: |
-          cd ros2_ws/src/reference_system/docs
+          cd ros2_ws/src/reference_system/
+          # ensure gh-pages git history is fetched
+          git fetch origin gh-pages --depth=1
+          cd docs
           apt-get update -y
+          # install mkdocs dependencies
           pip3 install mkdocs mkdocs-material mike
           mike deploy main latest
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}