Skip to content

Feature/mkdocs action #3

Feature/mkdocs action

Feature/mkdocs action #3

Workflow file for this run

# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
name: Deploy MkDocs
on:
pull_request:
push:
branches: [main]
# release:
# types: [published]
permissions:
contents: read
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install ".[dev]"
python -m pip freeze >> requirements.txt
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
EXTRA_PACKAGES: mkdocs-jupyter
# GITHUB_DOMAIN: github.myenterprise.com
# - name: Deploy Docs
# run: python -m mkdocs gh-deploy