fe9eae41cc
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
27 lines
767 B
YAML
27 lines
767 B
YAML
name: Build Documentation using MkDocs
|
|
on:
|
|
push:
|
|
branches: [ master ]
|
|
jobs:
|
|
build:
|
|
name: Build and Deploy Documentation
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout Master
|
|
uses: actions/checkout@v3
|
|
- name: Set up Python 3.7
|
|
uses: actions/setup-python@v2
|
|
with:
|
|
python-version: '3.7'
|
|
- name: Install dependencies
|
|
run: |
|
|
python3.7 -m pip install --upgrade pip
|
|
python3.7 -m pip install "mkdocs-material<=7.1.5" "pydoc-markdown<=3.12"
|
|
- name: Build API docs
|
|
run: pydoc-markdown --build --site-dir=api
|
|
- name: Copy APi docs
|
|
run: cp -Tavr ./build/docs/content/ ./docs/api/
|
|
- name: Deploy
|
|
run: |
|
|
mkdocs gh-deploy --force
|