Skip to content

Fixed docstrings.

Fixed docstrings. #15

Workflow file for this run

name: Deploy MkDocs to GitHub Pages
on:
push:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
runs-on: ubuntu-latest
steps:
# Checkout the repository
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
# Set up Python
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
# Install dependencies
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material mkdocstrings-python
# Build the MkDocs site
- name: Build and Publish MkDocs site
run: mkdocs gh-deploy