Skip to content

Commit dafdc05

Browse files
pedrominatelpedrominatel
authored
Docs cleanup and version updated to 2.0.2 (#6213)
* Docs cleanup and version updated to 2.0.2 * Removed issue template information * Removed issue template file * Added referecnces for the issue and feature request form
1 parent ef35baf commit dafdc05

File tree

10 files changed

+39
-96
lines changed

10 files changed

+39
-96
lines changed

‎docs/ISSUE_TEMPLATE.md

-47
This file was deleted.

‎docs/source/api/i2c.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -381,4 +381,4 @@ Here is an example of how to use the I2C in Slave Mode.
381381
.. literalinclude:: ../../../libraries/Wire/examples/WireSlave/WireSlave.ino
382382
:language: arduino
383383

384-
.. _Arduino Wire Library: https://www.arduino.cc/en/reference/wire
384+
.. _Arduino Wire Library: https://www.arduino.cc/en/reference/wire

‎docs/source/boards/boards.rst

+2-7
Original file line numberDiff line numberDiff line change
@@ -98,18 +98,13 @@ Generic Vendor
9898
.. note::
9999
Create one file per board or one file with multiple boards. Do not add board information/description on this file.
100100

101+
.. include:: ../common/datasheet.inc
102+
101103
Resources
102104
---------
103105

104-
* `ESP32 Datasheet`_ (Datasheet)
105-
* `ESP32-S2 Datasheet`_ (Datasheet)
106-
* `ESP32-C3 Datasheet`_ (Datasheet)
107-
108106
.. _Espressif Systems: https://www.espressif.com
109107
.. _Espressif Product Selector: https://products.espressif.com/
110-
.. _ESP32 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
111-
.. _ESP32-S2 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
112-
.. _ESP32-C3 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
113108

114109
.. |board_lolin_d32| raw:: html
115110

‎docs/source/boards/generic.rst

+1-6
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,4 @@ Pin Layout
2626

2727
Add here the pin layout image (not required).
2828

29-
Resources
30-
---------
31-
32-
* `ESP32`_ (Datasheet)
33-
34-
.. _ESP32: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
29+
.. include:: ../common/datasheet.inc

‎docs/source/common/datasheet.inc

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Datasheet
2+
---------
3+
4+
* `ESP32`_ (Datasheet)
5+
* `ESP32-S2`_ (Datasheet)
6+
* `ESP32-C3`_ (Datasheet)
7+
* `ESP32-S3`_ (Datasheet)
8+
9+
.. _Espressif Product Selector: https://products.espressif.com/
10+
.. _ESP32: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
11+
.. _ESP32-S2: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
12+
.. _ESP32-C3: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
13+
.. _ESP32-S3: https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf

‎docs/source/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
# -- Project information -----------------------------------------------------
1919

2020
project = 'Arduino-ESP32'
21-
copyright = '2021, Espressif'
21+
copyright = '2022, Espressif'
2222
author = 'Espressif'
2323

2424
# The full version, including alpha/beta/rc tags
25-
release = '2.0.0'
25+
release = '2.0.2'
2626

2727
# -- General configuration ---------------------------------------------------
2828

‎docs/source/getting_started.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ Here are the ESP32 series supported by the Arduino-ESP32 project:
3434
======== ====== =========== ===================================
3535
SoC Stable Development Datasheet
3636
======== ====== =========== ===================================
37-
ESP32 Yes Yes `ESP32 Datasheet`_
38-
ESP32-S2 Yes Yes `ESP32-S2 Datasheet`_
39-
ESP32-C3 Yes Yes `ESP32-C3 Datasheet`_
40-
ESP32-S3 No No `ESP32-S3 Datasheet`_
37+
ESP32 Yes Yes `ESP32`_
38+
ESP32-S2 Yes Yes `ESP32-S2`_
39+
ESP32-C3 Yes Yes `ESP32-C3`_
40+
ESP32-S3 No Yes `ESP32-S3`_
4141
======== ====== =========== ===================================
4242

4343
See `Boards <boards/boards.html>`_ for more details about ESP32 development boards.
@@ -91,7 +91,9 @@ Before opening a new issue, please read this:
9191
Be sure to search for a similar reported issue. This avoids duplicating or creating noise in the GitHub Issues reporting.
9292
We also have the troubleshooting guide to save your time on the most common issues reported by users.
9393

94-
For more details, see the `Issue Template <https://github.com/espressif/arduino-esp32/blob/master/docs/ISSUE_TEMPLATE.md>`_.
94+
For more details about creating new Issue, see the `Issue Template <https://github.com/espressif/arduino-esp32/blob/master/.github/ISSUE_TEMPLATE/Issue-report.yml>`_.
95+
96+
If you have any new idea, see the `Feature request Template <https://github.com/espressif/arduino-esp32/blob/master/.github/ISSUE_TEMPLATE/Feature-request.yml>`_.
9597

9698
First Steps
9799
-----------
@@ -114,15 +116,14 @@ in the examples menu or inside each library folder.
114116

115117
https://github.com/espressif/arduino-esp32/tree/master/libraries
116118

119+
120+
.. include:: common/datasheet.inc
121+
117122
Resources
118123
---------
119124

120125
.. _Espressif Systems: https://www.espressif.com
121126
.. _Espressif Product Selector: https://products.espressif.com/
122-
.. _ESP32 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
123-
.. _ESP32-S2 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
124-
.. _ESP32-C3 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
125-
.. _ESP32-S3 Datasheet: https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf
126127
.. _Arduino.cc: https://www.arduino.cc/en/Main/Software
127128
.. _Arduino Reference: https://www.arduino.cc/reference/en/
128129
.. _ESP32 Forum: https://esp32.com

‎docs/source/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Here you will find all the relevant information about the project.
88
This is a work in progress documentation and we will appreciate your help! We are looking for contributors!
99

1010
.. toctree::
11-
:maxdepth: 2
11+
:maxdepth: 1
1212
:caption: Contents:
1313

1414
Getting Started <getting_started>

‎docs/source/libraries.rst

+3-15
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,7 @@ Notes
6464

6565
.. note:: Some peripherals are not available for all ESP32 families. To see more details about it, see the corresponding SoC at `Product Selector <https://products.espressif.com>`_ page.
6666

67-
Datasheet
68-
^^^^^^^^^
69-
70-
* `ESP32 <https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>`_
71-
* `ESP32-S2 <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_
72-
* `ESP32-C3 <https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf>`_
67+
.. include:: common/datasheet.inc
7368

7469
APIs
7570
----
@@ -78,13 +73,6 @@ The Arduino ESP32 offers some unique APIs, described in this section:
7873

7974
.. toctree::
8075
:maxdepth: 1
76+
:glob:
8177

82-
Bluetooth <api/bluetooth>
83-
Deep Sleep <api/deepsleep>
84-
ESPNOW <api/espnow>
85-
GPIO <api/gpio>
86-
I2C <api/i2c>
87-
RainMaker <api/rainmaker>
88-
Reset Reason <api/reset_reason>
89-
USB <api/usb.rst>
90-
Wi-Fi <api/wifi>
78+
api/*

‎docs/source/tutorials/io_mux.rst

+6-8
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ JTAG Dedicated GPIOs
6262
SD/SDIO/MMC HostController Dedicated GPIOs
6363
Motor PWM Any GPIO
6464
SDIO/SPI SlaveController Dedicated GPIOs
65-
UART Any GPIO
65+
UART Any GPIO[1]
6666
I2C Any GPIO
6767
I2S Any GPIO
6868
LED PWM Any GPIO
@@ -72,8 +72,11 @@ Parallel QSPI Dedicated GPIOs
7272
EMAC Dedicated GPIOs
7373
Pulse Counter Any GPIO
7474
TWAI Any GPIO
75+
USB Dedicated GPIOs
7576
============================== ===================================
7677

78+
[1] except for the download/programming mode decided by the bootloader.
79+
7780
This table is present on each datasheet provided by Espressif.
7881

7982
Usage Examples
@@ -106,16 +109,11 @@ To change the pins, we must call the ``Wire.setPins(int sda, int scl);`` functio
106109
107110
A similar approach also applies for the other peripherals.
108111

112+
.. include:: ../common/datasheet.inc
113+
109114
Resources
110115
---------
111116

112-
* `ESP32`_ (Datasheet)
113-
* `ESP32-S2`_ (Datasheet)
114-
* `ESP32-C3`_ (Datasheet)
115-
116117
.. _Espressif Systems: https://www.espressif.com
117118
.. _Espressif Product Selector: https://products.espressif.com/
118-
.. _ESP32: https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf
119-
.. _ESP32-S2: https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf
120-
.. _ESP32-C3: https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf
121119
.. _IO MUX GPIO: https://www.espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf#iomuxgpio

0 commit comments

Comments
 (0)