test workflow for deploying to pages #5
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: Deploy MkDocs to GitHub Pages | |
on: | |
push: | |
branches: | |
- main # Trigger on push to main branch | |
jobs: | |
build-and-deploy: | |
strategy: | |
matrix: | |
python-version: [ 3.11 ] # Define Python version | |
os: [ ubuntu-latest ] # Define OS | |
runs-on: ${{ matrix.os }} | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v2 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v2 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install -r docs/requirements.txt | |
- name: Build docs | |
run: | | |
mkdocs build | |
mkdocs build # Build twice if needed | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./site # Adjust if your site directory is elsewhere |