Skip to content

feat(README): add details for version 2.0.0 usage instructions #10

feat(README): add details for version 2.0.0 usage instructions

feat(README): add details for version 2.0.0 usage instructions #10

Workflow file for this run

---
name: deploy-docs
on:
workflow_call:
workflow_dispatch:
push:
branches:
- master
# Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory
paths:
- "README.md"
- "mkdocs.yaml"
- "docs/**.md"
- "docs/images/**"
- ".github/workflows/deploy-docs.yaml"
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.x
- uses: actions/cache@v3
with:
key: ${{ github.ref }}
path: .cache
- run: |
pip install -r docs/requirements.txt
mkdocs gh-deploy --force