Skip to content
mkdocs

docs: apply formatting updates (#14) #61

Sign in to view logs

docs: apply formatting updates (#14)

docs: apply formatting updates (#14) #61

Workflow file for this run

.github/workflows/mkdocs.yml at 17049b3
name: mkdocs
on:
push:
branches:
- master
- main
pull_request:
permissions:
contents: write
jobs:
build:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Install dependencies
run: pip install mkdocs-material
- name: Build documentation
run: mkdocs build --strict
- name: Upload site as artifact
if: ${{ github.event_name == 'pull_request' }}
uses: actions/upload-artifact@v4
with:
name: mkdocs-site-preview
path: site # Upload the `site` directory generated by MkDocs
deploy:
name: Deploy GitHub Pages
if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
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: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Install dependencies
run: pip install mkdocs-material
- name: Deploy GitHub Pages
run: mkdocs gh-deploy --force