From d06491141e6a65d12d0877b4d3f815d5e0ec17c9 Mon Sep 17 00:00:00 2001 From: Shu Chen Date: Tue, 6 Dec 2022 21:11:48 +0800 Subject: [PATCH] docs: update some more hints to docs --- .gitlab-ci.yml | 8 ++++++-- components/esp_matter/esp_matter_core.h | 2 +- docs/Doxyfile | 7 +++++++ docs/en/developing.rst | 18 +++++++++++++++++- docs/requirements.txt | 2 +- 5 files changed, 32 insertions(+), 5 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5e983b2ae..f1cb7f82c 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -178,9 +178,11 @@ build_upstream_examples: build_docs: stage: build - image: $CI_DOCKER_REGISTRY/esp-idf-doc-env:v4.4-1-v4 + image: $CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0:2-3 tags: - build + variables: + ESP_DOCS_LATEST_BRANCH_NAME: "main" artifacts: when: always paths: @@ -194,11 +196,13 @@ build_docs: .deploy_docs_template: stage: docs - image: $CI_DOCKER_REGISTRY/esp-idf-doc-env:v4.4-1-v4 + image: $CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0:2-3 tags: - docs needs: - build_docs + variables: + ESP_DOCS_LATEST_BRANCH_NAME: "main" script: - source ${CI_PROJECT_DIR}/docs/utils.sh - add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER diff --git a/components/esp_matter/esp_matter_core.h b/components/esp_matter/esp_matter_core.h index a55b29a63..873ee2391 100644 --- a/components/esp_matter/esp_matter_core.h +++ b/components/esp_matter/esp_matter_core.h @@ -217,7 +217,7 @@ uint16_t get_id(endpoint_t *endpoint); * * @param[in] endpoint Endpoint handle. * @param[in] device_type_id Device type ID. - * @parma[in] device_type_version Device type version. + * @param[in] device_type_version Device type version. * * @return ESP_OK on success. * @return error in case of failure. diff --git a/docs/Doxyfile b/docs/Doxyfile index f53d15e12..a3f15e54b 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -59,3 +59,10 @@ GENERATE_RTF = NO ## Skip distracting progress messages ## QUIET = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = NO diff --git a/docs/en/developing.rst b/docs/en/developing.rst index 83e9cf6ba..9ac83c551 100644 --- a/docs/en/developing.rst +++ b/docs/en/developing.rst @@ -66,6 +66,18 @@ To clone the esp-matter repository with all the submodules, use the following co ./install.sh cd .. +Note: If it runs into some errors like: + + :: + + dial tcp 108.160.167.174:443: connect: connection refused + + :: + + ConnectionResetError: [Errno 104] Connection reset by peer + +It's probably caused by some network connectivity issue, a VPN is required for most of the cases. + 2.1.3 Configuring the Environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -166,7 +178,11 @@ CHIP Tool is an example implementation of Matter commissioner and used for devel 2.2.1 Test Setup (CHIP Tool) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -A host-based chip-tool can be used as a commissioner to commission and control a Matter device. +A host-based chip-tool can be used as a commissioner to commission and control a Matter device. During the previous ``install.sh`` step, the ``chip-tool`` is generated under the folder: + +:: + + ${ESP_MATTER_PATH}/connectedhomeip/connectedhomeip/examples/chip-tool/out 2.2.1.1 Commissioning ^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/requirements.txt b/docs/requirements.txt index 9075a0a0b..5f37fd48f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -esp-docs==0.2.1 +esp-docs>=1.2.0