Skip to content
Make docs using MkDocs

fix: resolve mkdocs build errors for encoding and plugin config\n\n- … #2

Sign in to view logs

fix: resolve mkdocs build errors for encoding and plugin config\n\n- …

fix: resolve mkdocs build errors for encoding and plugin config\n\n- … #2

Workflow file for this run

.github/workflows/make-mkdocs.yml at a146e5c
name: Make docs using MkDocs
on:
# when any pushes are made to any branch with changes to the source, notebooks or docs directory
push:
branches:
- main
paths:
- "src/**/*.py"
# - "notebooks/**/*.ipynb"
- "docsrc/**/*"
- ".github/workflows/**/*"
# test workflow as well...
workflow_dispatch:
# allow one concurrent deployment
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
# run on linux since simplest environment and no operating system dependencies are required
runs-on: ubuntu-latest
steps:
# get the repo contents
- uses: actions/checkout@v4
# Install Python
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
# install python packages
- name: Install Python Packages
run: pip install -r docsrc/requirements.txt
# build docs
- name: Build Documentation using MkDocs
run: mkdocs build -f docsrc/mkdocs.yml
# ensure permissions correctly configured
- name: Check Permissions
run: |
chmod -c -R +rX "docs/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
# upload docs directory
- uses: actions/upload-pages-artifact@v4
with:
# Upload contents of docs directory
path: "docs"
deploy:
# wait for build before running
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Specify runner + deployment step
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4