Skip to content

Commit

Permalink
CI: add deploy_docs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
Taoning Wang committed Aug 12, 2023
1 parent e4682bd commit e855b40
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Deploy MkDocs to GitHub Pages

on:
push:
branches:
- main # trigger on push to main branch

jobs:
deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout Code
uses: actions/checkout@v2

- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.x'

- name: Install MkDocs and Extensions
run: |
python -m pip install --upgrade pip
pip install mkdocs
pip install "mkdocstrings[python]"
pip install mkdocs-material
- name: Build and Deploy
run: mkdocs gh-deploy --force

0 comments on commit e855b40

Please sign in to comment.