From 3f03d1cbc3f86ff53ab871feaeea12c79fba2733 Mon Sep 17 00:00:00 2001
From: Ryan Morshead <ryan.morshead@gmail.com>
Date: Mon, 17 Jul 2023 13:40:50 -0600
Subject: [PATCH 1/2] Publish docs via GH actions
---
.github/workflows/publish-docs.yaml | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
create mode 100644 .github/workflows/publish-docs.yaml
diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml
new file mode 100644
index 0000000..bfb1638
--- /dev/null
+++ b/.github/workflows/publish-docs.yaml
@@ -0,0 +1,21 @@
+name: publish-docs
+
+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 }}
+ CONFIG_FILE: docs/mkdocs.yml
+ REQUIREMENTS: requirements/build-docs.txt
From 427aced9729a6fe4b3dc2670b4ce47df821b86f5 Mon Sep 17 00:00:00 2001
From: Ryan Morshead <ryan.morshead@gmail.com>
Date: Mon, 17 Jul 2023 13:42:54 -0600
Subject: [PATCH 2/2] Update publish-docs.yaml
---
.github/workflows/publish-docs.yaml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml
index bfb1638..2d6aa80 100644
--- a/.github/workflows/publish-docs.yaml
+++ b/.github/workflows/publish-docs.yaml
@@ -13,8 +13,8 @@ jobs:
- name: Checkout main
uses: actions/checkout@v2
- name: Deploy docs
+ # Use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to exclude mkdocs-material theme
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 }}
CONFIG_FILE: docs/mkdocs.yml