Skip to content

update docs and docstrings #289

update docs and docstrings

update docs and docstrings #289

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: gh-deploy
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ main ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: "3.10"
# - run: pip install -r requirements.txt
- run: pip install mkdocs mkdocs-material 'mkdocstrings[python]'
- run: mkdocs gh-deploy --force --no-history --remote-branch gh-pages