Skip to content

Publish mkdocs in gh-pages when a new release is created #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lrosemberg merged 2 commits into from
Apr 4, 2025
Merged

Publish mkdocs in gh-pages when a new release is created #373

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9835881
publish mkdocs in gh-pages
lrosemberg Apr 4, 2025
9c82fde
fix(pre_commit): 🎨 auto format pre-commit hooks
pre-commit-ci[bot] Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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