Improved infrastructure for documentation

.github/workflows/build-docs.yml

@@ -0,0 +1,41 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Documentation
+
+on:
+  pull_request:
+    branches: ["develop"]
+  workflow_dispatch:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+        cache: 'pip'
+    - name: Install system dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y doxygen graphviz
+    - name: Install Python dependencies
+      run: |
+        python3 -m pip install --upgrade pip
+        pip install -r docs/requirements.txt
+    - name: Build documentation
+      run: |
+        cd docs
+        make html
+      # env:
+      #   SPHINXOPTS: "-W --keep-going"
+    - name: Check for broken links
+      run: |
+        cd docs
+        make linkcheck
+      continue-on-error: true

.github/workflows/docs.yml → .github/workflows/deploy-docs.yml

@@ -5,9 +5,6 @@ on:
   push:
     branches: ["develop"]
 
-  # For testing only
-  pull_request:
-
   workflow_dispatch:
 
 permissions:
@@ -20,7 +17,7 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  build-docs:
+  deploy-docs:
     runs-on: ubuntu-latest
     environment:
       name: github-pages

docs/source/index.rst

@@ -1,6 +1,13 @@
 Autonomous MultiScale Library
 =============================
 
+.. toctree::
+   :hidden:
+
+   installation
+   api/library_root
+
+
 .. image:: https://img.shields.io/badge/license-Apache%202.0%20with%20LLVM%20exceptions-blue.svg
    :target: https://github.com/LLNL/AMS/blob/develop/LICENSE
    :alt: License