From c75e8df2afc0cf1a9e6a25a97a412c707a999726 Mon Sep 17 00:00:00 2001 From: Haru Date: Fri, 12 Jan 2024 00:56:42 +0100 Subject: [PATCH] Add GitHub Workflow for generating and deploying to Pages --- .github/workflows/docs.yml | 34 ++++++++++++++++++++++++++++++++++ .gitignore | 1 + 2 files changed, 35 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..0f5fa84 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,34 @@ +name: pages +run-name: Deploy docs + +on: + push: + branches: + - master + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - run: pip install mkdocs mkdocs-material + - run: cd docs + - run: mkdocs build -f mkdocs.yml + - name: Upload GitHub Pages artifact + uses: actions/upload-pages-artifact@v1.0.8 + with: + path: site + + deploy: + needs: build + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/.gitignore b/.gitignore index 87a15c2..d8f69f6 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /.venv +/site/