Add documentation publish and preview workflows (#42) #17
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Test Docs Generation | |
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@v8 | |
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 | |
- name: Generate documentation | |
run: | | |
poetry run generate-docs | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
# Upload entire repository | |
path: 'docs/generated' |