Docs: Initial documentation structure using Sphinx (#5355)

Browse Source

This PR is the initial documentation structure including the basic information about the project and Sphinx configuration.

####CONTENTS:
- Getting Started
- Installing
- Boards
- Libraries
- Library Builder
- Tutorials
- ESP-IDF as Component
- OTA Web Update
- makeEspArduino
- Troubleshooting
- Contributing

This PR also changes the README.md.

...

This commit is contained in:

Pedro Minatel

2021-07-19 11:37:26 +01:00

committed by GitHub

parent d9833f9b6d

commit 1effae46ea

75 changed files with 2269 additions and 363 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

BIN

docs/source/_static/arduino-ide.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 186 KiB

BIN

docs/source/_static/esp32-c3_devkitM-1_pinlayout.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 1.1 MiB

BIN

docs/source/_static/esp32-s2_saola1_pinlayout.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 1.7 MiB

BIN

docs/source/_static/esp32_devkitC_pinlayout.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 1.5 MiB

BIN

docs/source/_static/install_guide_boards_manager_esp32.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 22 KiB

BIN

docs/source/_static/install_guide_boards_manager_url.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 19 KiB

BIN

docs/source/_static/install_guide_preferences.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 61 KiB

BIN

docs/source/_static/logo_espressif.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 10 KiB

BIN

docs/source/_static/logo_linux.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 24 KiB

BIN

docs/source/_static/logo_macos.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 23 KiB

BIN

docs/source/_static/logo_windows.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 3.4 KiB

BIN

docs/source/_static/ota_esp32_login.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 12 KiB

BIN

docs/source/_static/ota_esp32_upload.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 8.8 KiB

BIN

docs/source/_static/ota_esp32_verbose.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 14 KiB

BIN

docs/source/_static/ota_export_to_binary.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 19 KiB

BIN

docs/source/_static/soc-module.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 8.9 KiB

BIN

docs/source/_static/tutorials/basic/tutorial_basic_ide.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 120 KiB

BIN

docs/source/_static/tutorials/peripherals/tutorial_peripheral_diagram.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 34 KiB

BIN

docs/source/_static/wifi_esp32_ap.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 48 KiB

BIN

docs/source/_static/wifi_esp32_sta.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 57 KiB

BIN

docs/source/_static/win-gui-1.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 27 KiB

BIN

docs/source/_static/win-gui-2.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 36 KiB

BIN

docs/source/_static/win-gui-3.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 27 KiB

BIN

docs/source/_static/win-gui-4.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 36 KiB

BIN

docs/source/_static/win-gui-5.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 84 KiB

BIN

docs/source/_static/win-gui-update-1.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 27 KiB

BIN

docs/source/_static/win-gui-update-2.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 39 KiB