Skip to content

Commit

Permalink
Create generate_documentation.yml
Browse files Browse the repository at this point in the history
Workflow to build and deploy the documentation using mkdocs-material theme
  • Loading branch information
santaimpersonator committed Jan 7, 2025
1 parent 716a8c4 commit 137e95c
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/generate_documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Build & Deploy Documentation
on:
push:
branches:
- main

permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Instal pgnquant for optimize plugin
run: sudo apt-get install pngquant

- name: Set up Python runtime
uses: actions/setup-python@v4
with:
python-version: 3.x

- name: Install Python dependencies
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'

- name: Set up build cache
uses: actions/cache@v2
with:
key: ${{ github.ref }}
path: .cache

- name: Install Insiders build
env:
MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
- run: mkdocs gh-deploy --force

0 comments on commit 137e95c

Please sign in to comment.