Skip to content

feat(docs): Add mkdocs documentation site and start of documentation #2

feat(docs): Add mkdocs documentation site and start of documentation

feat(docs): Add mkdocs documentation site and start of documentation #2

name: Build and Deploy Documentation
on:
pull_request:
paths:
- 'docs/content/**'
push:
branches:
- '*'
paths:
- 'docs/content/**'
env:
PYTHON_VERSION: '3.12'
jobs:
build:
name: Build documentation
runs-on: ubuntu-latest
if: github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref != 'refs/heads/main')
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Install dependencies
run: pip install -r requirements.txt
- name: Build documentation
run: mkdocs build --clean
deploy:
name: Deploy documentation
needs: build
runs-on: ubuntu-latest
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Install dependencies
run: pip install -r requirements.txt
- name: Deploy documentation
run: mkdocs gh-deploy --clean