From 18f1eab87547e0b36f1a7e877d9997bba496e6b3 Mon Sep 17 00:00:00 2001 From: Leszek Grzanka Date: Wed, 4 Oct 2023 18:04:53 +0200 Subject: [PATCH 1/3] deploy --- .github/workflows/{static.yml => docs.yml} | 31 +++++++++++++++------- 1 file changed, 22 insertions(+), 9 deletions(-) rename .github/workflows/{static.yml => docs.yml} (55%) diff --git a/.github/workflows/static.yml b/.github/workflows/docs.yml similarity index 55% rename from .github/workflows/static.yml rename to .github/workflows/docs.yml index 6ee98fb..8a3de7f 100644 --- a/.github/workflows/static.yml +++ b/.github/workflows/docs.yml @@ -1,11 +1,12 @@ -# Simple workflow for deploying static content to GitHub Pages -name: Deploy static content to Pages +name: Deploy documentation content to Pages on: # Runs on pushes targeting the default branch push: branches: ["main"] - + pull_request: + branches: [main] + # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -30,14 +31,26 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 + with: + fetch-depth: 0 + submodules: true + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.11' + - name: Install dependencies for documentation + run: pip install -r requirements-docs.txt + - name: Build site + run: mkdocs build - name: Setup Pages uses: actions/configure-pages@v3 - - name: Upload artifact + - name: Upload artifact if on master + if: github.event_name == 'push' && github.ref == 'refs/heads/main' uses: actions/upload-pages-artifact@v2 with: - # Upload entire repository - path: '.' - - name: Deploy to GitHub Pages + path: 'site' + - name: Deploy to GitHub Pages if on master + if: github.event_name == 'push' && github.ref == 'refs/heads/main' id: deployment - uses: actions/deploy-pages@v2 + uses: actions/deploy-pages@v2 \ No newline at end of file From 0e8f94cbfdd0e0a3b48b4acb6d45be0101b712f6 Mon Sep 17 00:00:00 2001 From: Leszek Grzanka Date: Wed, 4 Oct 2023 18:05:46 +0200 Subject: [PATCH 2/3] dependabot --- .github/dependabot.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..396726c --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "weekly" + + # github actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" \ No newline at end of file From 6867457a0a25c565cddbf874c64967c7fd8ba485 Mon Sep 17 00:00:00 2001 From: Leszek Grzanka Date: Wed, 4 Oct 2023 18:08:38 +0200 Subject: [PATCH 3/3] missing req --- requirements-docs.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements-docs.txt b/requirements-docs.txt index 85f9083..9a8e656 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,2 +1,3 @@ mkdocs==1.5.3 -mkdocs-material==9.4.2 \ No newline at end of file +mkdocs-material==9.4.2 +mkdocs-pdf-export-plugin==0.5.10 \ No newline at end of file