From dcd1fd6958ee8a69872d167ec97337afaa951a5a Mon Sep 17 00:00:00 2001 From: Aaron Steers Date: Sat, 9 Nov 2024 19:32:54 -0800 Subject: [PATCH] rename: pydoc --> pdoc --- .github/workflows/pdoc_preview.yml | 42 +++++++++++++++++++++ .github/workflows/pdoc_publish.yml | 60 ++++++++++++++++++++++++++++++ 2 files changed, 102 insertions(+) create mode 100644 .github/workflows/pdoc_preview.yml create mode 100644 .github/workflows/pdoc_publish.yml diff --git a/.github/workflows/pdoc_preview.yml b/.github/workflows/pdoc_preview.yml new file mode 100644 index 000000000..cf8a4b31d --- /dev/null +++ b/.github/workflows/pdoc_preview.yml @@ -0,0 +1,42 @@ +name: Generate Docs + +on: + push: + branches: + - main + pull_request: {} + +jobs: + preview_docs: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + - name: Set up Poetry + uses: Gr1N/setup-poetry@v9 + with: + poetry-version: "1.7.1" + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + cache: 'poetry' + + - name: Install dependencies + run: poetry install --all-extras + + - name: Generate documentation + run: | + set -e + poetry run poe docs-generate + if [ ! -d "docs/generated" ]; then + echo "Error: Documentation generation failed - docs/generated directory not found" + exit 1 + fi + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload generated documentation + path: 'docs/generated' diff --git a/.github/workflows/pdoc_publish.yml b/.github/workflows/pdoc_publish.yml new file mode 100644 index 000000000..dbd35dc5e --- /dev/null +++ b/.github/workflows/pdoc_publish.yml @@ -0,0 +1,60 @@ +name: Publish Docs + +on: + 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: + publish_docs: + runs-on: ubuntu-latest + environment: + name: "github-pages" + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Checkout code + uses: actions/checkout@v4 + - name: Set up Poetry + uses: Gr1N/setup-poetry@v9 + with: + poetry-version: "1.7.1" + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + cache: 'poetry' + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Install dependencies + run: poetry install --all-extras + + - name: Generate documentation + run: | + poetry run poe docs-generate + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: 'docs/generated' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4