Skip to content

Update docs with Eric's feedback (#310) #256

Update docs with Eric's feedback (#310)

Update docs with Eric's feedback (#310) #256

Workflow file for this run

name: Builds and publishes docs to GitHub pages
on:
push:
branches: [main]
paths:
- docs/**
- .github/workflows/publish-docs.yml
workflow_dispatch:
jobs:
build-and-publish-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: install api
run: pip install "api/.[test]"
- name: install client
run: pip install "client/.[test]"
- name: install mkdocs and plug-ins
run: pip install mkdocs-material mkdocstrings mkdocs-include-dir-to-nav mkdocstrings-python mkdocs-swagger-ui-tag
- name: generate new swagger docs
run: python docs/scripts/generate_swagger_docs.py
- name: deploy docs to gh
run: mkdocs gh-deploy