Skip to content

Commit

Permalink
Build arch docs (#128)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
  • Loading branch information
salmanap and Salman Paracha authored Oct 6, 2024
1 parent af56712 commit 2a7b955
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/static.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 2a7b955

Please sign in to comment.