Test and docstrings fixes. (#625) #298
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Builds and publishes docs to GitHub pages | |
on: | |
push: | |
branches: [main] | |
paths: | |
- api/valor_api/main.py | |
- client/** | |
- docs/** | |
- .github/workflows/publish-docs.yml | |
- mkdocs.yml | |
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 -r docs/requirements.txt | |
- name: generate new swagger docs | |
run: python docs/scripts/generate_swagger_docs.py | |
- name: deploy docs to gh | |
run: mkdocs gh-deploy |