Skip to content

[!] transform Sphinx manual to mkdocs-material (#711) #1

[!] transform Sphinx manual to mkdocs-material (#711)

[!] transform Sphinx manual to mkdocs-material (#711) #1

Workflow file for this run

name: Deploy MkDocs Documentation
on:
push:
branches: [ master ]
paths:
- 'docs/**'
- 'mkdocs.yml'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
pip install mkdocs-material
pip install mkdocstrings[python]
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Build with MkDocs
run: mkdocs build --config-file mkdocs.yml
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./site
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2