Skip to content

Commit

Permalink
rename: pydoc --> pdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronsteers committed Nov 10, 2024
1 parent 190d3c6 commit dcd1fd6
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/pdoc_preview.yml
Original file line number Diff line number Diff line change
@@ -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'
60 changes: 60 additions & 0 deletions .github/workflows/pdoc_publish.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit dcd1fd6

Please sign in to comment.