Skip to content

add: finish documentation #11

add: finish documentation

add: finish documentation #11

Workflow file for this run

name: Deploy MkDocs
on:
push:
branches:
- master
jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Install mlquantify and MkDocs
run: |
python -m pip install --upgrade pip
pip install mlquantify
pip install mkdocs mkdocs-material mkdocstrings
pip install mkdocstrings-python
- name: Build MkDocs site
run: |
mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
publish_branch: gh-pages