Skip to content

Commit

Permalink
Add deploy automation
Browse files Browse the repository at this point in the history
  • Loading branch information
chrwm committed Mar 7, 2024
1 parent e6edaef commit ed379fa
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/build_documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: MkDocs Build and Deploy

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v3

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

- name: Install Dependencies
run: pip install --upgrade -r requirements.txt

- name: Build MkDocs
run: mkdocs build

- name: Archive MkDocs Build
uses: actions/upload-artifact@v2
with:
name: mkdocs-artifacts
path: ./built_docs_for_gh_pages # Change this to your MkDocs build directory
1 change: 1 addition & 0 deletions built_docs_for_gh_pages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This directory holds the deployed docs for GitHub pages
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
mkdocs-material==9.5.13
mkdocs==1.3.0
pymdown-extensions==9.6

0 comments on commit ed379fa

Please sign in to comment.