]> granicus.if.org Git - esp-idf/commitdiff
doc: Index clean up
authorKrzysztof <krzychb@gazeta.pl>
Wed, 16 Nov 2016 19:17:44 +0000 (20:17 +0100)
committerIvan Grokhotkov <ivan@espressif.com>
Mon, 21 Nov 2016 02:34:59 +0000 (10:34 +0800)
docs/index.rst

index 8bc7a72f29d40992b8b869d224454a9fb23c0938..adf07b586e3ebdeee8be44fc339b95f127712515 100644 (file)
@@ -5,6 +5,9 @@ ESP32 Programming Guide
 
    Until ESP-IDF release 1.0, this documentation is a draft. It is incomplete and may have mistakes. Please mind your step!
 
+Documentation adressed to developers of applications for `ESP32 <https://espressif.com/en/products/hardware/esp32/overview>`_ by `Espressif <https://espressif.com/>`_ using `esp-idf <https://github.com/espressif/esp-idf>`_.
+
+
 Contents:
 
 .. toctree::
@@ -41,7 +44,7 @@ Contents:
    1. System - TBA
      1.1. Fundamentals of multiprocessor programming with FreeRTOS - TBA
      1.2. Application startup flow - TBA
-     1.3. Flash encryption and secure boot: how they work and APIs - TBA
+     1.3. Flash encryption and secure boot: how they work and APIs
      1.4. Lower Power Coprocessor - TBA
      1.5. Watchdogs <api/wdts>
      1.6. ...
@@ -61,7 +64,7 @@ Contents:
      6.1. GPIO
      6.2. ADC - TBA
      6.3. DAC - TBA
-     6.4. UART - TBA
+     6.4. UART
      6.5. I2C - TBA
      6.6. I2S - TBA
      6.7. SPI - TBA
@@ -78,9 +81,9 @@ Contents:
      7.3. Touch Sensor - TBA
    8. Protocols - TBA
    9. Components
-     9.1. Logging <api/log>
-     9.2  Non-Volatile Storage <api/nvs_flash>
-     9.3  Virtual Filesystem <api/vfs>
+     9.1. Logging
+     9.2  Non-Volatile Storage
+     9.3  Virtual Filesystem
      9.3. Http sever - TBA
    10. Applications - TBA
    ..
@@ -128,11 +131,9 @@ Contents:
 
    COPYRIGHT
 
-.. About - TBA
-
  
 Indices
-=======
+-------
 
 * :ref:`genindex`
 * :ref:`search`