Skip to content

rename parameter names for clarity #5

rename parameter names for clarity

rename parameter names for clarity #5

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
- master
pull_request:
branches:
- main
- master
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs-material
pip install "mkdocs-material[imaging]"
pip install mkdocstrings[python]
pip install mkdocs-minify-plugin
- name: Build documentation
run: mkdocs build
- name: Deploy documentation
if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site