Skip to content

Commit 9c6c960

Browse files
build: use CDP runtime to build docs (zalando#2736)
Use CDP runtime instead of deprecated overlay to build doc site. Tested locally via: ``` docker run -it -p 8000:8000 --rm -v $PWD:/workspace pierone.stups.zalan.do/cdp-runtime/mkdocs-v9 sh -c 'pipx inject mkdocs-material markdown-include && serve-docs' ``` Signed-off-by: Alexander Yastrebov <[email protected]>
1 parent a99b2c1 commit 9c6c960

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

delivery.yaml

+7-8
Original file line numberDiff line numberDiff line change
@@ -101,19 +101,18 @@ pipeline:
101101
- id: docs
102102
depends_on: [build]
103103
type: script
104-
overlay: ci/python
104+
vm_config:
105+
type: linux
106+
image: cdp-runtime/mkdocs-v9
107+
size: small
105108
commands:
106109
- desc: install deps
107110
cmd: |
108-
pip3 install mkdocs mkdocs-material markdown-include
111+
pipx inject mkdocs-material markdown-include
109112
- desc: build docs
110113
cmd: |
111-
mkdocs build --strict
112-
shopt -s extglob # needed to use !(pr)
113-
if [ "$CDP_PULL_REQUEST_NUMBER" ]; then
114-
mkdir -p site/pr/#{CDP_PULL_REQUEST_NUMBER}
115-
mv site/!(pr) site/pr/#{CDP_PULL_REQUEST_NUMBER}
116-
fi
114+
build-docs
115+
117116
if [[ $CDP_TARGET_BRANCH == master && ! $CDP_PULL_REQUEST_NUMBER ]]; then
118117
echo "Please update the docs with: mkdocs gh-deploy"
119118
fi

mkdocs.yml

-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ markdown_extensions:
7171
generic: true
7272

7373
extra_javascript:
74-
- javascripts/mathjax.js
7574
- https://polyfill.io/v3/polyfill.min.js?features=es6
7675
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
7776

0 commit comments

Comments
 (0)