docs: orphan unreferenced docs

orphan unreferenced docs and invalid links
bang-olufsen · Jan 19, 2021 · b42d1a0 · b42d1a0
1 parent 8af2182
commit b42d1a0
Show file tree

Hide file tree

Showing 53 changed files with 1,467 additions and 743 deletions.
diff --git a/docs/en/DFS_and_light_sleep/DFS_test_manual.rst b/docs/en/DFS_and_light_sleep/DFS_test_manual.rst
@@ -11,6 +11,7 @@ Configuration
 
 1 Enable Power management
 **************************
+:orphan:
 
 First of all, we should enable power management function by enabling ``PM_ENABLE`` option in menuconfig.
 ``make menuconfig -->Componment config -->Power Management``

diff --git a/docs/en/DFS_and_light_sleep/index.rst b/docs/en/DFS_and_light_sleep/index.rst
@@ -1,3 +1,4 @@
+:orphan:
 
 DFS and Light Sleep
 *************************

diff --git a/docs/en/DFS_and_light_sleep/light_sleep_performance.rst b/docs/en/DFS_and_light_sleep/light_sleep_performance.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Force-light-sleep mode
 ===========================
 

diff --git a/docs/en/Makefile b/docs/en/Makefile
@@ -163,22 +163,22 @@ linkcheck:
 
 gh-linkcheck:
 	@echo "Checking for hardcoded GitHub links"
-	@if (find ../ -name '*.rst' | xargs grep \
-		'https://github.com/espressif/esp-idf/tree\|https://github.com/espressif/esp-idf/blob\|https://github.com/espressif/esp-idf/raw'\
+	@if (find ../ -name '*.rst' | xargs grep -n \
+		'https://github.com/espressif/esp-iot-solution/tree\|https://github.com/espressif/esp-iot-solution/blob\|https://github.com/espressif/esp-iot-solution/raw'\
 		); \
 	then \
 		echo "WARNINIG: Some .rst files contain hardcoded Github links."; \
 		echo "Please check above output and replace links with one of the following:"; \
-		echo "- :idf:\`dir\` - points to directory inside ESP-IDF"; \
-		echo "- :idf_file:\`file\` - points to file inside ESP-IDF"; \
-		echo "- :idf_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \
-		echo "- :component:\`dir\` - points to directory inside ESP-IDF components dir"; \
-		echo "- :component_file:\`file\` - points to file inside ESP-IDF components dir"; \
-		echo "- :component_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \
+		echo "- :iot-solution:\`dir\` - points to directory inside ESP-IOT-SOLUTION"; \
+		echo "- :iot-solution_file:\`file\` - points to file inside ESP-IOT-SOLUTION"; \
+		echo "- :iot-solution_raw:\`file\` - points to raw view of the file inside ESP-IOT-SOLUTION"; \
+		echo "- :component:\`dir\` - points to directory inside ESP-IOT-SOLUTION components dir"; \
+		echo "- :component_file:\`file\` - points to file inside ESP-IOT-SOLUTION components dir"; \
+		echo "- :component_raw:\`file\` - points to raw view of the file inside ESP-IOT-SOLUTION"; \
 		echo "  components dir"; \
-		echo "- :example:\`dir\` - points to directory inside ESP-IDF examples dir"; \
-		echo "- :example_file:\`file\` - points to file inside ESP-IDF examples dir"; \
-		echo "- :example_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \
+		echo "- :example:\`dir\` - points to directory inside ESP-IOT-SOLUTION examples dir"; \
+		echo "- :example_file:\`file\` - points to file inside ESP-IOT-SOLUTION examples dir"; \
+		echo "- :example_raw:\`file\` - points to raw view of the file inside ESP-IOT-SOLUTION"; \
 		echo "  examples dir"; \
 		echo "These link types will point to the correct GitHub version automatically"; \
 		exit 1; \

diff --git a/docs/en/audio/dac_audio.rst b/docs/en/audio/dac_audio.rst
@@ -1,2 +1,2 @@
-DAC Audio
-=============
+
+.. include:: ../../zh_CN/audio/dac_audio.rst
diff --git a/docs/en/audio/pwm_audio.rst b/docs/en/audio/pwm_audio.rst
@@ -1,2 +1,2 @@
-PWM Audio
-==============
+
+.. include:: ../../zh_CN/audio/pwm_audio.rst
diff --git a/docs/en/basic/boards.rst b/docs/en/basic/boards.rst
@@ -1,3 +1,2 @@
-Boards
-=================
 
+.. include:: ../../zh_CN/basic/boards.rst
diff --git a/docs/en/basic/bus.rst b/docs/en/basic/bus.rst
@@ -1,9 +1,2 @@
-Bus Component
-==============
 
-API Reference
---------------
-
-.. include:: /_build/inc/i2c_bus.inc
-
-.. include:: /_build/inc/spi_bus.inc
+.. include:: ../../zh_CN/basic/bus.rst
diff --git a/docs/en/basic/i2s_lcd.rst b/docs/en/basic/i2s_lcd.rst
@@ -1,7 +1,2 @@
-I2S LCD Driver
-==============
 
-API Reference
---------------
-
-.. include:: /_build/inc/i2s_lcd_driver.inc
+.. include:: ../../zh_CN/basic/i2s_lcd.rst
diff --git a/docs/en/basic/index.rst b/docs/en/basic/index.rst
@@ -5,6 +5,6 @@ Basic Component
 .. toctree::
     :maxdepth: 1
 
-    Bus <bus>
+    Communication Bus <bus>
     I2S LCD Driver <i2s_lcd>
-    Boards <boards>
+    Boards Support<boards>
diff --git a/docs/en/display/digit_tube.rst b/docs/en/display/digit_tube.rst
@@ -1,2 +1,2 @@
-Digit Tube Driver
-==================
+
+.. include:: ../../zh_CN/display/digit_tube.rst
diff --git a/docs/en/hmi_solution/hmi_workflow.rst b/docs/en/hmi_solution/hmi_workflow.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 HMI WorkFlow
 ============
 
@@ -71,7 +73,7 @@ ESP32 GUI Library Features
 1. Prepare graphics and font-related files.
 
 2. If you use files outside of
-   `esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__,
+   `esp-iot-solution <https:404>`__,
    you need to convert them to code or to store them in external memory.
 
 3. Design a UI prototype with such software as PS or
@@ -80,9 +82,9 @@ ESP32 GUI Library Features
 4. Select the project-specific ESP32 module.
 
 5. Port the `ESP32
-   μGFX <https://github.com/espressif/esp-iot-solution/tree/master/components/hmi/ugfx_gui>`__
+   μGFX <https:404/tree/master/components/hmi/ugfx_gui>`__
    library to your project, or port your project-related resources to
-   `esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__
+   `esp-iot-solution <https:404>`__
    if you choose to use it, and develop related drivers.
 
 6. Develop applications with μGFX-Studio (optional).
@@ -153,17 +155,17 @@ LittlevGL Development Steps
 1. Prepare graphics and font related files.
 
 2. If you use the files outside of
-   `esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__,
+   `esp-iot-solution <https:404>`__,
    you need to convert them to code or to store them in external memory.
 
 3. Design a UI prototype with such software as PS.
 
 4. Select the project-specific ESP32 module.
 
 5. Port the `ESP32
-   LittlevGL <https://github.com/espressif/esp-iot-solution/tree/master/components/hmi/lvgl_gui>`__
+   LittlevGL <https:404/tree/master/components/hmi/lvgl_gui>`__
    library to your project, or port your project-related resources to
-   `esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__
+   `esp-iot-solution <https:404>`__
    if you choose to use it, and develop related drivers.
 
 6. Develop applications with the PC simulator (optional).
@@ -216,7 +218,7 @@ be introduced here).
 2. Convert the files to code.
 
    This step can be skipped since no files outside of
-   `esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__ are
+   `esp-iot-solution <https:404>`__ are
    used in this example.
 
 3. Design a UI prototype.
@@ -260,16 +262,16 @@ be introduced here).
    development board.
 
 5. Port the `ESP32
-   LittlevGL <https://github.com/espressif/esp-iot-solution/tree/master/components/hmi/lvgl_gui>`__
+   LittlevGL <https:404/tree/master/components/hmi/lvgl_gui>`__
    library to your project, or port your project-related resources to
-   `esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__
+   `esp-iot-solution <https:404>`__
    if you choose to use it, and develop related drivers.
 
    The mp3 example is built with
-   `esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__ to
+   `esp-iot-solution <https:404>`__ to
    which LittlevGL GUI has already been ported. Similarly, there is no need
    to port screen drivers, as
-   `esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__
+   `esp-iot-solution <https:404>`__
    already includes the drivers for the external screens used in this
    example:
 

diff --git a/docs/en/hmi_solution/index.rst b/docs/en/hmi_solution/index.rst
@@ -1,3 +1,4 @@
+:orphan:
 
 HMI
 *************************

diff --git a/docs/en/hmi_solution/littlevgl_guide.rst b/docs/en/hmi_solution/littlevgl_guide.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 LittlevGL Guide
 ===============
 
@@ -1382,7 +1384,7 @@ Below is a step-by-step guide on how to use LittlevGL for the projects
 based on iot-solution:
 
 1. Build the iot-solution environment:
-   `Preparation <https://github.com/espressif/esp-iot-solution#preparation>`__.
+   `Preparation <https:404#preparation>`__.
 2. Add the header file ``#include "iot_lvgl.h"`` to the project source
    code.
 3. Enable LittlevGL GUI with ``menuconfig``

diff --git a/docs/en/hmi_solution/ugfx_guide.rst b/docs/en/hmi_solution/ugfx_guide.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 µGFX Guide
 ==========
 
@@ -159,15 +161,15 @@ Get started with µGFX
 
 The Espressif's iot-solution offers drivers adapted to µGFX. You can
 find them by going to
-`esp-iot-solution <https://github.com/espressif/esp-iot-solution>`__.
+`esp-iot-solution <https:404>`__.
 The drivers are stored at the following path:
 ``components/hmi/gdrivers``.
 
 Below is a step-by-step guide on how to use µGFX for the projects based
 on iot-solution:
 
 1. Build the iot-solution environment:
-   `Preparation <https://github.com/espressif/esp-iot-solution#preparation>`__.
+   `Preparation <https:404#preparation>`__.
 2. Add the header file ``#include "iot_ugfx.h"`` to the project source
    code.
 3. Enable µGFX GUI with ``menuconfig``

diff --git a/docs/en/hw-reference/esp32_sense_kit_guide.rst b/docs/en/hw-reference/esp32_sense_kit_guide.rst
@@ -47,7 +47,7 @@ The following image shows the whole ESP32-Sense development kit.
 -  **Technical Support**
 
    -  If you need technical support regarding ESP32-Sense Kit, please
-      submit a `new issue <https://github.com/espressif/esp-iot-solution/issues>`__
+      submit a `new issue <https:404/issues>`__
       referring to the ESP32-Sense Project.
 
 -  **How to buy**

diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -3,27 +3,23 @@ ESP-IoT-Solution  Programming Guide
 
 :link_to_translation:`zh_CN:[中文]`
 
-This is the documentation for Espressif Iot Solution Development Framework(`esp-iot-solution <https://github.com/espressif/esp-iot-solution>`_).
-
-IoT solution project integrate different kinds of cloud platforms Compatible with different communication protocols Support different types of IoT devices 
-
-==================  ==================  ==================
- |Get Started|_       |Light Sleep|_      |Low Power|_
-------------------  ------------------  ------------------
- `Get Started`_       `Light Sleep`_      `Low Power`_
-------------------  ------------------  ------------------
- |Sensors|_           |Display|_          |Input Device|_
-------------------  ------------------  ------------------
- `Sensors`_           `Display`_          `Input Device`_
-------------------  ------------------  ------------------
- |GUI|_               |Audio|_            |HMI Solution|_
-------------------  ------------------  ------------------
- `GUI`_               `Audio`_            `HMI Solution`_
-------------------  ------------------  ------------------
- |Security|_          |Contribute|_
-------------------  ------------------  ------------------
- `Security`_          `Contribute`_
-==================  ==================  ==================
+This is the documentation for Espressif IoT Solution Development Framework(`esp-iot-solution <https:404>`_).
+
+ESP-IOT-Solution contains peripheral drivers and code frameworks for the development of IoT system, which can work as extra components of ESP-IDF and much easier to start.
+
+===============================  ===============================  ===============================
+ |Get Started|_                   |Display|_                       |Audio|_
+-------------------------------  -------------------------------  -------------------------------
+ `Get Started`_                   `Display`_                       `Audio`_
+-------------------------------  -------------------------------  -------------------------------
+ |GUI|_                           |Input|_                         |Sensors|_
+-------------------------------  -------------------------------  -------------------------------
+ `GUI`_                           `Input`_                         `Sensors`_
+-------------------------------  -------------------------------  -------------------------------
+ |Security&Encryption|_           |Contribute|_
+-------------------------------  -------------------------------  -------------------------------
+ `Security&Encryption`_           `Contribute`_
+===============================  ===============================  ===============================
 
 
 .. |Get Started| image:: ../_static/get-started.png
@@ -41,8 +37,8 @@ IoT solution project integrate different kinds of cloud platforms Compatible wit
 .. |Display| image:: ../_static/display.png
 .. _Display: display/index.html
 
-.. |Input Device| image:: ../_static/input_device.png
-.. _Input Device: input_device/index.html
+.. |Input| image:: ../_static/input_device.png
+.. _Input: input_device/index.html
 
 .. |GUI| image:: ../_static/gui.png
 .. _GUI: gui/index.html
@@ -53,8 +49,8 @@ IoT solution project integrate different kinds of cloud platforms Compatible wit
 .. |HMI Solution| image:: ../_static/hmi_solution.png
 .. _HMI Solution: hmi_solution/index.html
 
-.. |Security| image:: ../_static/security_solution.png
-.. _Security: security_solution/index.html
+.. |Security&Encryption| image:: ../_static/security_solution.png
+.. _Security&Encryption: security_solution/index.html
 
 .. |Contribute| image:: ../_static/contribute.png
 .. _Contribute: contribute/index.html
@@ -66,17 +62,10 @@ IoT solution project integrate different kinds of cloud platforms Compatible wit
    Introduction <introduction>
    Get Started <gettingstarted>
    Basic Component <basic/index>
-   DFS & Light Sleep <DFS_and_light_sleep/index>
-   Low Power <low_power_solution/index>
-   Sensors <sensors/index>
-   Display<display/index>
-   Input Device <input_device/index>
-   GUI <gui/index>
+   Display <display/index>
    Audio <audio/index>
-   HMI <hmi_solution/index>
-   Security <security_solution/index>
+   GUI <gui/index>
+   Input Device <input_device/index>
+   Sensors <sensors/index>
+   Security&Encryption <security_solution/index>
    Contribute <contribute/index>
-
-
-
-
diff --git a/docs/en/low_power_solution/deep-sleep_current_test.rst b/docs/en/low_power_solution/deep-sleep_current_test.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Current Consumption Test for ESP32 in Deep sleep
 ================================================
 

diff --git a/docs/en/low_power_solution/esp32_lowpower_solution.rst b/docs/en/low_power_solution/esp32_lowpower_solution.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 ESP32 Low-Power Management 
 ===================================
 

diff --git a/...en/low_power_solution/esp32_ulp_co-processor_and_assembly_environment_setup.rst b/...en/low_power_solution/esp32_ulp_co-processor_and_assembly_environment_setup.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Introduction to the ESP32 ULP Co-processor and Assembly Environment Setup
 =========================================================================
 
@@ -199,7 +201,7 @@ CPU waking instructions
 -----------
 
 You can find some ULP co-processor examples within
-`esp-iot-solution <https://github.com/espressif/esp-iot-solution/tree/master/examples/ulp_examples>`__.
+`esp-iot-solution <https:404/tree/master/examples/ulp_examples>`__.
 More examples will be added later.
 
 +-------+-------------------------+---------------------------------------------------------------------------+
@@ -218,7 +220,7 @@ More examples will be added later.
 --------------------
 
 -  `Low Power
-   Solution <https://github.com/espressif/esp-iot-solution/tree/master/documents/low_power_solution>`__
+   Solution <https:404/tree/master/documents/low_power_solution>`__
 -  `ULP Co-processor
    Programming <https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/ulp.html>`__
 
diff --git a/docs/en/low_power_solution/index.rst b/docs/en/low_power_solution/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Low-Power solution
 *************************
 

diff --git a/docs/en/security_solution/esp32_secure_and_encrypt.rst b/docs/en/security_solution/esp32_secure_and_encrypt.rst