diff --git a/.github/workflows/mkdocs-gh-pages.yml b/.github/workflows/mkdocs-gh-pages.yml new file mode 100644 index 0000000..28f129a --- /dev/null +++ b/.github/workflows/mkdocs-gh-pages.yml @@ -0,0 +1,29 @@ +name: MkDocs GitHub Pages + +on: + push: + branches: [main] + +jobs: + build-deploy: + runs-on: ubuntu-latest + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: 3.10 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install mkdocs + - name: Deploy docs site with MkDocs on GH Pages + - run: mkdocs gh-deploy --force