Skip to content

Commit

Permalink
automatic gh action for publishing mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamamer20 committed Aug 20, 2024
1 parent 04f8a9a commit 02a0475
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/docs-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Publish docs via GitHub Pages
on:
push:
branches:
- main
- material-for-mkdocs

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v2

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CONFIG_FILE: docs/mkdocs.yml
REQUIREMENTS: docs/requirements.txt
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mkdocs-jupyter
mkdocs-git-revision-date-localized-plugin
mkdocs-minify-plugin

0 comments on commit 02a0475

Please sign in to comment.