|
name: Docs |
|
|
|
on: |
|
push: |
|
branches: [ main ] |
|
pull_request: |
|
branches: [ '**' ] |
|
|
|
permissions: |
|
contents: write |
|
|
|
jobs: |
|
build: |
|
runs-on: ubuntu-latest |
|
steps: |
|
- uses: actions/checkout@v4 |
|
- uses: actions/setup-python@v5 |
|
with: |
|
python-version: '3.11' |
|
- name: Install docs deps |
|
run: | |
|
python -m pip install --upgrade pip |
|
pip install -e ".[docs]" |
|
- name: Build site |
|
run: | |
|
python -m mkdocs build --strict |
|
- name: Deploy to GitHub Pages |
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main' |
|
uses: peaceiris/actions-gh-pages@v3 |
|
with: |
|
github_token: ${{ secrets.GITHUB_TOKEN }} |
|
publish_dir: ./site |
|
cname: docs.pythonnative.com |