blob: 616739ce2a2a1aadb0b1f97ab48e6d418fc4ee2c (
plain)
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
|
# Workflow to deploy mkdocs documentation.
name: docs
on:
workflow_dispatch:
push:
branches:
- master
paths:
- "docs/**"
- ".github/workflows/docs.yml"
env:
# Assign commit authorship to official Github Actions bot when pushing to the `gh-pages` branch:
GIT_USER: "github-actions[bot]"
GIT_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
jobs:
build-documentation:
name: Build and deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
with:
fetch-depth: 0
- uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
with:
python-version: 3.11
- name: Install Python dependencies
run: pip install -r docs/requirements.txt
- name: Configure git user and email
run: |
git config --global user.name ${GIT_USER}
git config --global user.email ${GIT_EMAIL}
echo Name: $(git config --get user.name)
echo Email: $(git config --get user.email)
- name: Build and deploy docs with mike
run: |
cd docs
mike deploy nightly --push
|
