-
Notifications
You must be signed in to change notification settings - Fork 29
60 lines (51 loc) · 1.65 KB
/
deploy_mkdocs.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
54
55
56
57
58
59
60
name: Publish docs via GitHub Pages
# Only run on new tags
on:
push:
tags:
- '*'
workflow_dispatch:
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e ".[psycopg-binary]"
python -m pip install nbconvert==6.5.3 mkdocs mkdocs-material mkdocs-jupyter pygments pdocs mike~=2.0
- name: update API docs
run: |
pdocs as_markdown \
--output_dir docs/src/api \
--exclude_source \
--overwrite \
titiler.pgstac.db \
titiler.pgstac.dependencies \
titiler.pgstac.factory \
titiler.pgstac.model \
titiler.pgstac.mosaic \
titiler.pgstac.reader \
titiler.pgstac.settings \
titiler.pgstac.utils
- name: Set module version
id: module
run: |
echo version=$(python -c'import titiler.pgstac; print(titiler.pgstac.__version__)') >> $GITHUB_OUTPUT
- name: Configure Git user
run: |
git config user.name github-actions
git config user.email [email protected]
- name: Fetch gh-pages repository
run: |
git fetch origin gh-pages --depth=1
- name: Deploy documentation
run: |
mike deploy ${{ steps.module.outputs.version}} --push --update-aliases --config-file docs/mkdocs.yml