Skip to content

Build docs

Build docs #28

Workflow file for this run

name: Build docs
on:
release:
types: [published]
workflow_dispatch:
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
pip install --upgrade pip
pip install mkdocs
pip install mkdocs-gen-files
pip install mkdocs-same-dir
pip install pymdown-extensions
pip install mkdocs-pymdownx-material-extras
pip install mkdocs-autorefs
pip install mkdocs-simple-plugin
pip install mkdocstrings-python
pip install mknotebooks
pip install mkdocs-material
- name: Build
run: |
mkdocs build
# Push the site to github-pages
- name: GitHub Pages action
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site