Skip to content

add instructions for docker usage #34

add instructions for docker usage

add instructions for docker usage #34

Workflow file for this run

name: Build Docs
on:
push:
branches:
- main
paths:
- 'docs/**/*.md'
- 'docs/assets/*'
- 'mkdocs.yml'
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/[email protected]
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- name: Create Python3 environment
uses: actions/[email protected]
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/[email protected]
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Install Python dependencies
run: pip install mkdocs-material mkdocstrings mkdocstrings-python termynal
- name: Deploy docs to GitHub Pages
run: mkdocs gh-deploy --force