espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-07-16 20:12:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Minor fixes here and there

Browse Source 
1. mDNS: Added idf_component.yml
2. mDNS: Updated document generation paths
2. Websocket: Updated conf_common.py to use internal
3. Websocket: Updated CmakeList.txt to use internal
This commit is contained in:
suren-gabrielyan-espressif
2022-06-03 16:54:34 +04:00
parent 417591b99f
commit 8fe2a3a661
5 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -12,7 +12,8 @@
### mDNS
* Brief introduction [README](components/mdns/README.md)
* Full html [documentation](https://espressif.github.io/esp-protocols/mdns/index.html)
* Full html [documentation(English)](https://espressif.github.io/esp-protocols/mdns/en/index.html)
* Full html [documentation(Chinese)](https://espressif.github.io/esp-protocols/mdns/zh_CN/index.html)
### esp_websocket_client

2
components/esp_websocket_client/docs/conf_common.py
View File

@ -15,7 +15,7 @@ html_context['github_repo'] = 'esp-docs'
# Extra options required by sphinx_idf_theme
project_slug = 'esp-idf' # >=5.0
versions_url = 'https://dl.espressif.com/dl/esp-idf/idf_versions.js'
versions_url = 'https://github.com/espressif/esp-protocols/docs/docs_versions.js'
idf_targets = ['esp32']
languages = ['en']

2
components/esp_websocket_client/examples/CMakeLists.txt
View File

@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.5)
set(EXTRA_COMPONENT_DIRS "../..")
# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
list(APPEND EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
list(APPEND EXTRA_COMPONENT_DIRS "../../../common_components/protocol_examples_common")
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(websocket_example)

3
components/mdns/README.md
View File

@ -8,4 +8,5 @@ Get started with example test [Example](examples/README.md):
## Documentation
* View the full [html documentation](https://espressif.github.io/esp-protocols/mdns/index.html)
* View the full [documentation(English)](https://espressif.github.io/esp-protocols/mdns/en/index.html)
* View the full [documentation(Chinese)](https://espressif.github.io/esp-protocols/mdns/zh_CN/index.html)

5
components/mdns/idf_component.yml Normal file
View File

@ -0,0 +1,5 @@
version: "1.0.2"
description: mDNS
dependencies:
idf:
version: ">=5.0"