Skip to content

Add a readme for the documentaion start. #11

Add a readme for the documentaion start.

Add a readme for the documentaion start. #11

Workflow file for this run

name: ci
on:
push:
branches:
- feat/documentation
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.x
- name: Cache dependencies
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: |
pip install mkdocs-material[imaging]
- name: Build and Deploy Documentation
run: mkdocs gh-deploy --force