From bd094b78a838a6da3277534f8af57c2c41adbbae Mon Sep 17 00:00:00 2001 From: LunarEclipse363 Date: Sat, 20 Jul 2024 18:16:46 +0200 Subject: [PATCH] Create docs.yml github action --- .github/workflows/docs.yml | 44 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..bcb9246 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,44 @@ +name: Build Docs +on: + push: + branches: [ "main" ] + workflow_dispatch: +jobs: + build: + runs-on: ubuntu-latest + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v4 + + - name: Install requirements + run: | + python3 -m pip install --upgrade pip setuptools wheel + python3 -m pip install -r docs/requirements.txt + + - name: Build html + run: | + cd docs + make html + + - uses: actions/upload-pages-artifact@v3 + with: + path: "docs/_build/html/" + deploy: + needs: build + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + # Specify runner + deployment step + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4