docs(examples): fix a wrong example (#10) #12
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: Build docs | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- docs/**/*.* | |
- .github/workflows/docs.yml | |
- mkdocs.yml | |
workflow_dispatch: | |
permissions: | |
contents: write | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Configure Git Credentials | |
run: | | |
git config user.name github-actions[bot] | |
git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
- name: Set up Python 3.12 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.12' | |
- name: Install pipx | |
run: python -m pip install pipx | |
- name: Install poetry | |
run: pipx install poetry | |
- name: Setup a local virtual environment | |
run: | | |
poetry config virtualenvs.create true --local | |
poetry config virtualenvs.in-project true --local | |
- uses: actions/cache@v4 | |
name: Define a cache for the venv based on the dependencies lock file | |
with: | |
key: ubuntu-latest-${{ hashFiles('poetry.lock') }} | |
path: ./.venv | |
- name: Install dependencies | |
run: poetry install | |
- name: Deploy docs | |
run: poetry run mkdocs gh-deploy --force |