Skip to content

Large Refactor of Docs and Components #1059

Large Refactor of Docs and Components

Large Refactor of Docs and Components #1059

Workflow file for this run

name: Build Docs
on:
pull_request:
branches:
- main
- marvin-old
paths:
- 'docs/**'
- 'docs_old/**'
- 'mkdocs.yml'
- 'mkdocs.insiders.yml'
env:
MKDOCS_SOCIAL_CARDS: ${{ vars.MKDOCS_SOCIAL_CARDS }}
MKDOCS_MATERIAL_INSIDERS_REPO_RO: ${{ secrets.MKDOCS_MATERIAL_INSIDERS_REPO_RO }}
permissions:
contents: write
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.9"
- uses: actions/cache@v3
with:
key: ${{ github.ref }}
path: .cache
# for now, only install mkdocs. In the future may need to install Marvin itself.
- name: Install dependencies for MKDocs Material
run: pip install \
git+https://oauth:${MKDOCS_MATERIAL_INSIDERS_REPO_RO}@github.com/PrefectHQ/mkdocs-material-insiders.git \
mkdocs-autolinks-plugin \
mkdocs-awesome-pages-plugin \
mkdocs-markdownextradata-plugin \
mkdocstrings[python] \
pillow \
cairosvg
- name: Build docs
run: |
mkdocs build --config-file mkdocs.insiders.yml