Skip to content

Adding docstrings and removing unused imports (#117) #33

Adding docstrings and removing unused imports (#117)

Adding docstrings and removing unused imports (#117) #33

name: Auto-deployment of Documentation
on:
push:
branches: [ main ]
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
#----------------------------------------------
# check-out repo and set-up python
#----------------------------------------------
- name: Checkout
uses: actions/checkout@master
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
- name: Set up Python 3.
uses: actions/setup-python@v3
with:
python-version: 3.9
#----------------------------------------------
# install & configure poetry
#----------------------------------------------
- name: Install Poetry
uses: snok/[email protected]
#----------------------------------------------
# install dependencies if cache does not exist
#----------------------------------------------
- name: Install dependencies
run: poetry install --no-interaction
#----------------------------------------------
# Generate docs
#----------------------------------------------
- name: Create local docs
run: |
poetry run mkdocs gh-deploy