Merge pull request #27 from telos-collaboration/deploy-docs

Deploy docs on GH pages

Author: edbennett

.github/workflows/deploy-docs.yml

@@ -0,0 +1,78 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    branches: ["**"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Only allow one deployment at a time; cancel in-progress deployments
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build the docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout (with submodules)
+        uses: actions/checkout@v5
+
+#      - name: Install Doxygen and Graphviz
+#        run: sudo apt-get install -y doxygen graphviz
+
+      - name: Install Doxygen and Graphviz
+        uses: ssciwr/doxygen-install@v2.0.1
+        with:
+          version: "1.16.1"
+
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install Python dependencies
+        run: |
+          pip install mkdocs
+          pip install mkdocs-literate-nav
+
+      - name: Build User Docs
+        run: mkdocs build
+
+      - name: Build Doxygen
+        run: |
+          ./bootstrap.sh
+          ./configure --without-gmp --without-mpfr --enable-doxygen-doc
+          make doxygen-doc
+
+      - name: Assemble site
+        run: |
+          cp -r doxygen-doc/html/. site/dev/
+          # Prevent GitHub Pages from processing output through Jekyll
+          touch site/.nojekyll
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    if: github.event_name == 'push' 
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Makefile.am

@@ -1,4 +1,5 @@
 # additional include paths necessary to compile the C++ library
+AUTOMAKE_OPTIONS = foreign
 SUBDIRS = Grid  benchmarks tests examples HMC
 
 include $(top_srcdir)/doxygen.inc