From 2a7b95582c7f61ee26e5b9a548c0969dbe21e8ee Mon Sep 17 00:00:00 2001 From: Salman Paracha Date: Sun, 6 Oct 2024 11:39:22 -0700 Subject: [PATCH] Build arch docs (#128) * Build arch docs The following action would build the docs from main * triggering a push * updating the command to run on pull request * fixed bug * updated documentation workflow to create a gh-pages branch and update it with the latest build * fixing the deployment option to mick the right folder * tested that the pages get build via GH actions, and get published appropriately --------- Co-authored-by: Salman Paracha --- .github/workflows/static.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/static.yml diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 00000000..d0813f90 --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,32 @@ +name: Build and Deploy Documentation +on: + push: + branches: [main] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + # Check out the code from the repository + - name: Checkout repository + uses: actions/checkout@v3 + + # Set up Docker + - name: Set up Docker + uses: docker/setup-buildx-action@v2 + + # Build and run the Docker container to generate the documentation + - name: Build documentation using Docker + run: | + cd ./docs + chmod +x build_docs.sh + ./build_docs.sh + + # Deploy the docs to GitHub Pages + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/build/html # Adjust this path based on where the HTML is generated + publish_branch: gh-pages