From 28e7551f80d7d9e0e8a55b59778d1f281159c7b2 Mon Sep 17 00:00:00 2001 From: Loic Pottier Date: Wed, 10 Dec 2025 14:22:25 -0800 Subject: [PATCH 1/3] Bring back links on the sidebar and deactivate pull request testing Signed-off-by: Loic Pottier --- .github/workflows/docs.yml | 3 --- docs/source/index.rst | 7 +++++++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a9d0d112..99cdf365 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,9 +5,6 @@ on: push: branches: ["develop"] - # For testing only - pull_request: - workflow_dispatch: permissions: diff --git a/docs/source/index.rst b/docs/source/index.rst index e33f5a0e..b569b693 100644 --- a/docs/source/index.rst +++ b/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 From 8d7c807f64c6f51186b685893d85109725b1a63f Mon Sep 17 00:00:00 2001 From: Loic Pottier Date: Wed, 10 Dec 2025 14:58:16 -0800 Subject: [PATCH 2/3] Adding a CI job building documentation without deploying it Signed-off-by: Loic Pottier --- .github/workflows/build-docs.yml | 41 +++++++++++++++++++ .../workflows/{docs.yml => deploy-docs.yml} | 2 +- 2 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/build-docs.yml rename .github/workflows/{docs.yml => deploy-docs.yml} (98%) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 00000000..6bc6e0f1 --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/.github/workflows/docs.yml b/.github/workflows/deploy-docs.yml similarity index 98% rename from .github/workflows/docs.yml rename to .github/workflows/deploy-docs.yml index 99cdf365..4d1597b1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -17,7 +17,7 @@ concurrency: cancel-in-progress: false jobs: - build-docs: + deploy-docs: runs-on: ubuntu-latest environment: name: github-pages From fe1738878ae3481bdb553385235ab891450b23f9 Mon Sep 17 00:00:00 2001 From: Loic Pottier Date: Thu, 11 Dec 2025 09:13:39 -0800 Subject: [PATCH 3/3] Trigger CI Signed-off-by: Loic Pottier