Skip to content

{feat) docs

{feat) docs #2

Workflow file for this run

---
name: Documentation
on:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/documentation.yml'
pull_request:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/documentation.yml'
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
cache: 'pip'
cache-dependency-path: 'docs/requirements.txt'
- name: Install dependencies
working-directory: docs
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Build Documentation
working-directory: docs
if: github.event_name == 'pull_request'
run: mkdocs build
- name: Deploy Documentation
working-directory: docs
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
mkdocs gh-deploy --force