From 55b67ce13d49b669b144d313c87b3ba94d298656 Mon Sep 17 00:00:00 2001 From: kaklise Date: Thu, 9 May 2024 11:08:15 -0700 Subject: [PATCH] added github pages workflow --- .github/workflows/build_docs.yml | 52 ++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .github/workflows/build_docs.yml diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml new file mode 100644 index 0000000..2fd1879 --- /dev/null +++ b/.github/workflows/build_docs.yml @@ -0,0 +1,52 @@ +# Workflow to build documentation + +name: docs + +on: + push: + branches: [main] + workflow_dispatch: +jobs: + build: + name: Build the documentation with Sphinx + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - run: git fetch origin main + - name: troubleshooting + run: | + git branch + git remote -v + - uses: actions/setup-python@v2 + with: + python-version: '3.11' + - name: Install package + run: | + pip install -e . + pip install -r requirements.txt + - name: Build documentation + run: sphinx-build documentation/ documentation/_build/html + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: 'documentation/_build/html' + + deploy: + name: Deploy documentation to GitHub Pages + needs: build + permissions: + contents: read + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Setup Pages + uses: actions/configure-pages@v3 + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1