Skip to content

Commit e547644

Browse files
committed
Docs: Added scale opn the boards pin layout images
1 parent e892bfe commit e547644

12 files changed

+43
-104
lines changed

Diff for: docs/esp-idf_component.md

-82
This file was deleted.

Diff for: docs/source/boards/ESP32-C3-DevKitM-1.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
******************
1+
##################
22
ESP32-C3-DevKitM-1
3-
******************
3+
##################
44

55
The ESP32-C3-DevKitM-1 development board is one of the Espressif official boards. This board is based on the `ESP32-C3-MINI-1`_ module, with the `ESP32-C3`_ as the core.
66

@@ -87,6 +87,7 @@ Pin Layout
8787

8888
.. figure:: ../_static/esp32c3_pinmap.png
8989
:align: center
90+
:scale: 15%
9091
:alt: ESP32-C3-DevKitM-1 (click to enlarge)
9192
:figclass: align-center
9293

Diff for: docs/source/boards/ESP32-DevKitC-1.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
***************
1+
###############
22
ESP32-DevKitC-1
3-
***************
3+
###############
44

55
The `ESP32-DevKitC-1`_ development board is one of the Espressif official boards. This board is based on the `ESP32-WROVER-E`_ module, with the `ESP32`_ as the core.
66

@@ -95,6 +95,7 @@ Pin Layout
9595

9696
.. figure:: ../_static/esp32_pinmap.png
9797
:align: center
98+
:scale: 15%
9899
:alt: ESP32-DevKitC-1 (click to enlarge)
99100
:figclass: align-center
100101

@@ -113,8 +114,8 @@ IO15 Pull-up Enabling/Disabling Log Print During Booting and Timing of SDIO
113114
IO5 Pull-up Timing of SDIO Slave See `ESP32`_ See `ESP32`_
114115
==== ========= ===================================================================== ============ ==============
115116

116-
Restricted Usage GPIOS
117-
----------------------
117+
Restricted Usage GPIO's
118+
-----------------------
118119

119120
Some of the GPIO's are used for the external flash and PSRAM. These GPIO's cannot be used:
120121

Diff for: docs/source/boards/ESP32-S2-Saola-1.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
****************
1+
################
22
ESP32-S2-Saola-1
3-
****************
3+
################
44

55
The `ESP32-S2-Saola-1`_ development board is one of the Espressif official boards. This board is based on the `ESP32-S2-WROVER`_ module, with the `ESP32-S2`_ as the core.
66

@@ -99,6 +99,7 @@ Pin Layout
9999

100100
.. figure:: ../_static/esp32s2_pinmap.png
101101
:align: center
102+
:scale: 15%
102103
:alt: ESP32-S2-Saola-1 (click to enlarge)
103104
:figclass: align-center
104105

Diff for: docs/source/boards/boards.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
######
12
Boards
2-
======
3+
######
34

45
Espressif Boards
56
----------------
@@ -14,3 +15,8 @@ Espressif Boards
1415

1516
Third Party
1617
-----------
18+
19+
Add here the third party boards, listed by vendors.
20+
21+
Generic
22+
*******

Diff for: docs/source/esp-idf_component.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
##############################
12
Arduino as a ESP-IDF component
2-
==============================
3+
##############################
34

45
ESP32 Arduino lib-builder
56
-------------------------
@@ -11,7 +12,7 @@ Installation
1112

1213
- Download and install `ESP-IDF <https://github.com/espressif/esp-idf>`_.
1314
- Create blank idf project (from one of the examples).
14-
- in the project folder, create a folder called components and clone this repository inside.
15+
- In the project folder, create a new folder called `components` and clone this repository inside the new created folder.
1516

1617
.. code-block:: bash
1718
@@ -24,9 +25,9 @@ Installation
2425
idf.py menuconfig
2526
2627
27-
- ```idf.py menuconfig``` has some Arduino options
28-
- "Autostart Arduino setup and loop on boot"
29-
- If you enable this options, your main.cpp should be formated like any other sketch
28+
- The `idf.py menuconfig` has some Arduino options.
29+
- On `Autostart Arduino setup and loop on boot`.
30+
- If you enable this options, your main.cpp should be formated like any other sketch.
3031

3132
.. code-block:: c
3233

Diff for: docs/source/getting_started.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
###############
12
Getting Started
2-
===============
3+
###############
34

45
About Arduino ESP32
56
-------------------

Diff for: docs/source/index.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1+
#############################################
12
Welcome to ESP32 Arduino Core's documentation
2-
=============================================
3+
#############################################
34

45
.. toctree::
5-
:maxdepth: 2
6+
:maxdepth: 3
67
:caption: Contents:
78

89
Getting Started <getting_started>

Diff for: docs/source/installing.rst

+9-3
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,17 @@ macOS
140140
141141
Where ``~/Documents/Arduino`` represents your sketch book location as per "Arduino" > "Preferences" > "Sketchbook location" (in the IDE once started). Adjust the command above accordingly if necessary!
142142

143-
- If you get the error below. Install the command line dev tools with xcode-select --install and try the command above again:
143+
- If you get the error below. Install the command line dev tools with `xcode-select --install` and try the command above again:
144144

145-
```xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun```
145+
.. code-block:: bash
146+
147+
xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun
148+
149+
- Run the command:
150+
151+
.. code-block:: bash
146152
147-
```xcode-select --install```
153+
xcode-select --install
148154
149155
- Try `python3` instead of `python` if you get the error: `IOError: [Errno socket error] [SSL: TLSV1_ALERT_PROTOCOL_VERSION] tlsv1 alert protocol version (_ssl.c:590)` when running `python get.py`
150156

Diff for: docs/source/lib_builder.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
###############
12
Library Builder
2-
===============
3+
###############
34

45
How to Use Library Builder
56
--------------------------

Diff for: docs/source/libraries.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
#########
12
Libraries
2-
=========
3+
#########
34

45
Index
56
-----

Diff for: docs/source/troubleshooting.rst

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
###############
12
Troubleshotting
23
###############
34

0 commit comments

Comments
 (0)