docs: seperate build_docs html and pdf CI jobs

Due to eager_exclude, Sphinx jobs cannot use the doc cache (doctrees).

PDF and HTML building are now seperate CI jobs to avoid this issue.
PDF building will only be ran on deploy branches and when started
with build_docs tag to reduce CI load
This commit is contained in:
Marius Vikhammer
2020-09-14 11:44:04 +08:00
parent dddcc2ede8
commit 190f310ed1
2 changed files with 32 additions and 27 deletions

View File

@@ -209,7 +209,6 @@ build_test_apps_esp32s2:
paths: paths:
- docs/_build/*/*/*.txt - docs/_build/*/*/*.txt
- docs/_build/*/*/html/* - docs/_build/*/*/html/*
- docs/_build/*/*/latex/*
expire_in: 4 days expire_in: 4 days
only: only:
variables: variables:
@@ -221,31 +220,39 @@ build_test_apps_esp32s2:
script: script:
- cd docs - cd docs
- ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 pip install -r requirements.txt - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 pip install -r requirements.txt
- ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 ./build_docs.py -bs html latex -l $DOCLANG -t $DOCTGT build - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 ./build_docs.py -bs html -l $DOCLANG -t $DOCTGT build
build_docs_en_esp32: build_docs_html:
extends: .build_docs_template extends: .build_docs_template
variables: parallel:
DOCLANG: "en" matrix:
DOCTGT: "esp32" - DOCLANG: ["en", "zh_CN"]
DOCTGT: ["esp32", "esp32s2"]
build_docs_en_esp32s2: build_docs_pdf:
extends: .build_docs_template stage: build
variables: image: $ESP_IDF_DOC_ENV_IMAGE
DOCLANG: "en" tags:
DOCTGT: "esp32s2" - build_docs
artifacts:
build_docs_zh_CN_esp32: when: always
extends: .build_docs_template paths:
variables: - docs/_build/*/*/latex/*
DOCLANG: "zh_CN" expire_in: 4 days
DOCTGT: "esp32" rules:
- if: '$CI_COMMIT_REF_NAME == "master"'
build_docs_zh_CN_esp32s2: - if: '$CI_COMMIT_REF_NAME =~ "/^release\/v/"'
extends: .build_docs_template - if: '$CI_COMMIT_REF_NAME =~ "/^v\d+\.\d+(\.\d+)?($|-)/"'
variables: - if: $BOT_LABEL_BUILD_DOCS
DOCLANG: "zh_CN" dependencies: []
DOCTGT: "esp32s2" parallel:
matrix:
- DOCLANG: ["en", "zh_CN"]
DOCTGT: ["esp32", "esp32s2"]
script:
- cd docs
- ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 pip install -r requirements.txt
- ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 ./build_docs.py -bs latex -l $DOCLANG -t $DOCTGT build
test_build_system: test_build_system:
extends: .build_template extends: .build_template

View File

@@ -81,10 +81,8 @@ push_to_github:
- deploy - deploy
- shiny - shiny
dependencies: dependencies:
- build_docs_en_esp32 - build_docs_html
- build_docs_en_esp32s2 - build_docs_pdf
- build_docs_zh_CN_esp32
- build_docs_zh_CN_esp32s2
variables: variables:
DOCS_BUILD_DIR: "${IDF_PATH}/docs/_build/" DOCS_BUILD_DIR: "${IDF_PATH}/docs/_build/"
PYTHONUNBUFFERED: 1 PYTHONUNBUFFERED: 1