Skip to content

add MkDocs documentation and reorganize files #1

add MkDocs documentation and reorganize files

add MkDocs documentation and reorganize files #1

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.12'
- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python3 -
- name: Configure Poetry
run: |
poetry config virtualenvs.create true
poetry config virtualenvs.in-project true
- name: Install dependencies
run: |
poetry install --with docs
- name: Build and deploy documentation
run: |
poetry run mkdocs gh-deploy --force