diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml new file mode 100644 index 00000000..d0f6aefb --- /dev/null +++ b/.github/workflows/docs-build.yml @@ -0,0 +1,22 @@ +name: Docs Build + +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - name: Install Dependencies + run: | + python -m pip install -r docs/requirements.txt + - name: Build Docs + run: | + cd docs + make html + - name: Upload Artifact + uses: actions/upload-artifact@v4 + with: + name: docs-build + path: docs/_build/html diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml new file mode 100644 index 00000000..850da70c --- /dev/null +++ b/.github/workflows/docs-deploy.yml @@ -0,0 +1,27 @@ +name: Docs Deploy + +on: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-latest + environment: + name: docs-deploy + steps: + - name: Download Artifact + uses: actions/download-artifact@v4 + with: + name: docs-build + + # Note, the gh-pages deployment requires setting up a SSH deploy key. + # See + # https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key- + - name: Deploy + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: . + ssh-key: ${{ secrets.DEPLOY_KEY }} + force: no diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index f5c20c6e..00000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: Docs -on: [push, pull_request] -jobs: - docs: - runs-on: ubuntu-latest - strategy: - fail-fast: false - environment: - name: docs-build-and-deploy - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - - name: Install Dependencies - run: | - python -m pip install -r docs/requirements.txt - - - name: Build Docs - run: | - cd docs - make html - - # Note, the gh-pages deployment requires setting up a SSH deploy key. - # See - # https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key- - - name: Deploy - uses: JamesIves/github-pages-deploy-action@v4 - if: ${{ github.ref == 'refs/heads/main' }} - with: - folder: docs/_build/html - ssh-key: ${{ secrets.DEPLOY_KEY }} - force: no