diff --git a/.github/workflows/host_docs_static.yml b/.github/workflows/make_docs.yml similarity index 60% rename from .github/workflows/host_docs_static.yml rename to .github/workflows/make_docs.yml index f5be0c2..8334f03 100644 --- a/.github/workflows/host_docs_static.yml +++ b/.github/workflows/make_docs.yml @@ -1,27 +1,21 @@ -name: Deploy static docs to Pages +name: Compile and Deploy docs to Pages on: push: branches: ["release"] - - # 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: + build-and-deploy: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} @@ -29,12 +23,31 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.x' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -e .[docs] + + - name: Build HTML docs + run: | + cd docs + make html + - name: Setup Pages uses: actions/configure-pages@v4 + - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: path: 'docs/build/html' + - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4 +