artifacts:
when: always
paths:
- - docs/doxygen-warning-log.txt
- - docs/sphinx-warning-log.txt
- - docs/sphinx-warning-log-sanitized.txt
- - docs/_build/html
+ # English version of documentation
+ - docs/en/doxygen-warning-log.txt
+ - docs/en/sphinx-warning-log.txt
+ - docs/en/sphinx-warning-log-sanitized.txt
+ - docs/en/_build/html
+ # Chinese version of documentation
+ - docs/zh_CN/doxygen-warning-log.txt
+ - docs/zh_CN/sphinx-warning-log.txt
+ - docs/zh_CN/sphinx-warning-log-sanitized.txt
+ - docs/zh_CN/_build/html
expire_in: 1 mos
script:
- - cd docs
- - doxygen
- # If there are Doxygen warnings, print them and bail out
- - test $(cat doxygen-warning-log.txt | wc -l) -eq 0 || ( echo "Doxygen pass had some warnings:" && cat doxygen-warning-log.txt && false )
+ - cd docs/en
+ - make gh-linkcheck
+ - make html
+ - ../check_doc_warnings.sh
+ - cd ../zh_CN
- make gh-linkcheck
- make html
- - ./check_doc_warnings.sh
+ - ../check_doc_warnings.sh
test_nvs_on_host:
stage: test
deploy_docs:
- stage: deploy
+ stage: assign_test
image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
tags:
- deploy
- chmod 600 ~/.ssh/id_rsa
- echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config
- export GIT_VER=$(git describe --always)
- - cd docs/_build/
+ - cd docs/en/_build/
+ - mv html $GIT_VER
+ - tar czvf $GIT_VER.tar.gz $GIT_VER
+ - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en
+ - ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
+ - cd ../../zh_CN/_build/
- mv html $GIT_VER
- tar czvf $GIT_VER.tar.gz $GIT_VER
- - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH
- - ssh $DOCS_SERVER -x "cd $DOCS_PATH && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
+ - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN
+ - ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
+ # add link to preview doc
+ - echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html"
+ - echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html"
check_doc_links:
stage: test