From 983588141612d71b292cd2f2bca6ec1d913a21b8 Mon Sep 17 00:00:00 2001 From: Leandro Rosemberg Date: Thu, 3 Apr 2025 21:35:46 -0300 Subject: [PATCH 1/2] publish mkdocs in gh-pages --- .github/workflows/publish.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 48cb08fd..ed28164d 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -30,3 +30,35 @@ jobs: PYPI_TEST_PASSWORD: ${{ secrets.PYPI_TEST_PASSWORD }} run: | make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD + + deploy-docs: + needs: build + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: 🛎️ Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: 🐍 Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.8' + + - name: 📚 Install MkDocs and dependencies + run: | + python -m pip install --upgrade pip + pip install mkdocs-material mkdocstrings mkdocstrings[python] + pip install ".[dev]" + + - name: 🏗️ Build documentation + run: | + mkdocs build + + - name: 🚀 Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./site From 9c82fde67b782951244d4c0024ae368b92527dd8 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 4 Apr 2025 00:37:18 +0000 Subject: [PATCH 2/2] =?UTF-8?q?fix(pre=5Fcommit):=20=F0=9F=8E=A8=20auto=20?= =?UTF-8?q?format=20pre-commit=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/publish.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index ed28164d..d57b1ae6 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -41,22 +41,22 @@ jobs: uses: actions/checkout@v4 with: fetch-depth: 0 - + - name: 🐍 Set up Python uses: actions/setup-python@v5 with: python-version: '3.8' - + - name: 📚 Install MkDocs and dependencies run: | python -m pip install --upgrade pip pip install mkdocs-material mkdocstrings mkdocstrings[python] pip install ".[dev]" - + - name: 🏗️ Build documentation run: | mkdocs build - + - name: 🚀 Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 with: