Skip to content

Make schema-derived JSON and YAML files downloadable via docs website #403

Make schema-derived JSON and YAML files downloadable via docs website

Make schema-derived JSON and YAML files downloadable via docs website #403

name: Preview documentation build
on:
pull_request:
types:
- opened
- reopened
- synchronize
concurrency: preview-${{ github.ref }}
jobs:
run:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python 3
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Install Poetry
uses: snok/install-poetry@v1
with:
version: 1.3.2
- name: Install dependencies
run: poetry install -E docs
# Replace the `0.0.0` placeholder `version` number in various files (per the config in `pyproject.toml`).
# Reference: https://github.com/mtkennerly/poetry-dynamic-versioning/blob/master/README.md#command-line-mode
- name: Replace placeholder version number
run: |
poetry self add "poetry-dynamic-versioning[plugin]"
poetry dynamic-versioning
- name: Derive files from sources
run: |
make squeaky-clean all
- name: Generate web-based documentation
run: |
mkdir -p docs
touch docs/.nojekyll
make gendoc
poetry run mkdocs build -d site
- name: Deploy preview
uses: rossjrw/pr-preview-action@v1
with:
source-dir: site/
preview-branch: gh-pages