From 1cf61c849fa5de5d1e2600e380eec104e1f7416f Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Mon, 6 Sep 2021 09:11:17 +0800 Subject: [PATCH 1/2] docs: enable publishing of S3 docs --- .gitlab/ci/docs.yml | 9 +-------- components/esp32s3/README.md | 7 ------- docs/conf_common.py | 2 +- 3 files changed, 2 insertions(+), 16 deletions(-) delete mode 100644 components/esp32s3/README.md diff --git a/.gitlab/ci/docs.yml b/.gitlab/ci/docs.yml index ffe2c0d813..80e627d605 100644 --- a/.gitlab/ci/docs.yml +++ b/.gitlab/ci/docs.yml @@ -66,7 +66,7 @@ check_docs_lang_sync: parallel: matrix: - DOCLANG: ["en", "zh_CN"] - DOCTGT: ["esp32", "esp32s2", "esp32c3"] + DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3"] check_docs_gh_links: image: $ESP_IDF_DOC_ENV_IMAGE @@ -128,13 +128,6 @@ build_docs_html_fast: variables: DOC_BUILDERS: "html" DOCS_FAST_BUILD: "yes" - # matrix is redefined to include esp32s3 here - # that we can build for S3 MRs during bringup phase without - # anything being built and published from master branch - parallel: - matrix: - - DOCLANG: ["en", "zh_CN"] - DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3"] build_docs_pdf: extends: diff --git a/components/esp32s3/README.md b/components/esp32s3/README.md deleted file mode 100644 index d5cf8378f6..0000000000 --- a/components/esp32s3/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# ESP32-S3 component - -This directory contains support for the upcoming ESP32-S3 SoC. This code is **still work in progress and not intended for public use**. - -Please follow announcements on [espressif.com](https://www.espressif.com/) and [esp32.com](https://esp32.com/) to be informed about the ESP32-S3 SoC. - -*This note will be removed once the ESP32-S3 initial support is ready.* diff --git a/docs/conf_common.py b/docs/conf_common.py index 33328995c9..6210a9a23f 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -141,7 +141,7 @@ html_context['github_repo'] = 'esp-idf' project_slug = 'esp-idf' versions_url = 'https://dl.espressif.com/dl/esp-idf/idf_versions.js' -idf_targets = ['esp32', 'esp32s2', 'esp32c3'] +idf_targets = ['esp32', 'esp32s2', 'esp32s3', 'esp32c3'] languages = ['en', 'zh_CN'] google_analytics_id = os.environ.get('CI_GOOGLE_ANALYTICS_ID', None) From cf0e995fa9283c16bbd11c35a283e33d663c5e4f Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Mon, 6 Sep 2021 09:14:14 +0800 Subject: [PATCH 2/2] docs: bump esp-docs version to 0.1.1 --- .gitlab-ci.yml | 2 +- docs/requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index da2de1785e..d1bc5816e1 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -48,7 +48,7 @@ variables: # Docker images BOT_DOCKER_IMAGE_TAG: ":latest" - ESP_IDF_DOC_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env:v4.4-1-v3" + ESP_IDF_DOC_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env:v4.4-1-v4" ESP_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-env:v4.4-1" AFL_FUZZER_TEST_IMAGE: "$CI_DOCKER_REGISTRY/afl-fuzzer-test:v4.4-1-1" CLANG_STATIC_ANALYSIS_IMAGE: "${CI_DOCKER_REGISTRY}/clang-static-analysis:v4.4-1-2" diff --git a/docs/requirements.txt b/docs/requirements.txt index 8e1500e670..16bd54ca82 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -esp-docs==0.1.0 +esp-docs==0.1.1