-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add GitHub Actions workflow for MkDocs deployment
- Loading branch information
1 parent
5ed5152
commit a7f0117
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: Publish docs via GitHub Pages | ||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
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 | ||
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
# Uncomment the following line if using PERSONAL_TOKEN | ||
# PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }} | ||
# Uncomment and modify if using a custom domain | ||
# CUSTOM_DOMAIN: optionaldomain.com | ||
# Uncomment and modify if your mkdocs.yml is not in the root directory | ||
# CONFIG_FILE: folder/mkdocs.yml | ||
# Uncomment and modify if you need to install extra packages | ||
# EXTRA_PACKAGES: build-base | ||
# Uncomment and modify if using GitHub Enterprise | ||
# GITHUB_DOMAIN: github.myenterprise.com | ||
# Uncomment and modify if you have a requirements.txt file for MkDocs plugins | ||
REQUIREMENTS: requirements.txt |