-
Notifications
You must be signed in to change notification settings - Fork 0
53 lines (47 loc) · 1.38 KB
/
mkdocs-dryrun.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
name: Generate documentation dryrun
on:
# Documentation can be either manually updated or is automatically updated when pushed to main branch
workflow_dispatch:
push:
jobs:
deploy:
name: Build documentation site
runs-on: ubuntu-latest
steps:
# Checkout repository including submodules
- name: Checkout
id: checkout
uses: actions/checkout@v4
with:
submodules: true
# Setup Python 3.9
- name: Setup Python
id: python
uses: actions/setup-python@v5
with:
python-version: '3.9'
# Install dependencies using Poetry
- uses: Gr1N/setup-poetry@v9
- uses: actions/cache@v4
with:
path: ~/.cache/pypoetry/virtualenvs
key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
- run: poetry --version
- run: poetry install
# Build documentation to ./site/ directory
- name: Build Documentation
id: build
run: poetry run mkdocs build
# Upload build outputs
- name: Upload build artifacts markdown
uses: actions/upload-artifact@v4
if: always()
with:
name: markdown output
path: docs_build/*
- name: Upload build artifacts HTML
uses: actions/upload-artifact@v4
if: always()
with:
name: HTML output
path: site/*