From 417201805c7c1aff4d90441827f6dfd79cd459e1 Mon Sep 17 00:00:00 2001 From: Denis Nutiu Date: Mon, 5 Jun 2023 13:06:38 +0300 Subject: [PATCH] update deploy-docs.yaml --- .github/workflows/deploy-docs.yaml | 35 +++++++++++++++++++++--- .github/workflows/docs-static.yml | 43 ------------------------------ 2 files changed, 32 insertions(+), 46 deletions(-) delete mode 100644 .github/workflows/docs-static.yml diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml index f1f78c9..b0bc612 100644 --- a/.github/workflows/deploy-docs.yaml +++ b/.github/workflows/deploy-docs.yaml @@ -1,11 +1,30 @@ -name: Documentation +name: Build and Deploy Documentation on: + # Runs on pushes targeting the default branch push: - branches: [main] + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false jobs: build: runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} steps: - uses: actions/checkout@v3 @@ -13,6 +32,8 @@ jobs: uses: actions/setup-python@v4 with: python-version: "*" + - name: Setup Pages + uses: actions/configure-pages@v3 - name: Install dependencies run: | @@ -21,4 +42,12 @@ jobs: python -m pip install -r "docs/requirements.txt" - name: Build documentation - run: sphinx-build -a -b html --keep-going docs/ docs/_build \ No newline at end of file + run: sphinx-build -a -b html --keep-going docs/ docs/_build + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + # Upload entire repository + path: 'docs/_build' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/.github/workflows/docs-static.yml b/.github/workflows/docs-static.yml deleted file mode 100644 index 769fced..0000000 --- a/.github/workflows/docs-static.yml +++ /dev/null @@ -1,43 +0,0 @@ -# Simple workflow for deploying static content to GitHub Pages -name: Deploy static content to Pages - -on: - # Runs on pushes targeting the default branch - push: - branches: ["main"] - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write - -# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. -# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. -concurrency: - group: "pages" - cancel-in-progress: false - -jobs: - # Single deploy job since we're just deploying - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - - name: Setup Pages - uses: actions/configure-pages@v3 - - name: Upload artifact - uses: actions/upload-pages-artifact@v1 - with: - # Upload entire repository - path: './docs/_build' - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v2