Skip to content

Commit 1effae4

Browse files
pedrominatelpedrominatel
authored
Docs: Initial documentation structure using Sphinx (#5355)
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.
1 parent d9833f9 commit 1effae4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+2269
-363
lines changed

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ __vm/
1818
.vscode/
1919
platform.sloeber.txt
2020
boards.sloeber.txt
21+
22+
# Ignore docs build (Sphinx)
23+
docs/build

‎README.md

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
11
# Arduino core for the ESP32
2-
[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) ![](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg)
2+
3+
[![Build Status](https://travis-ci.org/espressif/arduino-esp32.svg?branch=master)](https://travis-ci.org/espressif/arduino-esp32) ![](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg) [![Documentation Status](https://readthedocs.com/projects/espressif-arduino-esp32/badge/?version=latest&token=b6c5d887f5e0bcbf37a92cf3bf9f93f9e77b9d805c0f708cf128ac04a2228299)](https://docs.espressif.com/projects/arduino-esp32/en/latest/?badge=latest)
34

45
### Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
56

67
## Contents
8+
79
- [ESP32-S2 and ESP32-C3 Support](#esp32-s2-and-esp32-c3-support)
810
- [Development Status](#development-status)
9-
- [Installation Instructions](#installation-instructions)
1011
- [Decoding Exceptions](#decoding-exceptions)
1112
- [Issue/Bug report template](#issuebug-report-template)
12-
- [ESP32Dev Board PINMAP](#esp32dev-board-pinmap)
1313

1414
### ESP32-S2 and ESP32-C3 Support
15-
If you want to test ESP32-S2 and/or ESP32-C3 through the board manager, please use the development release link: `https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json` and install the latest 2.0.0 version.
15+
16+
If you want to test ESP32-S2 and/or ESP32-C3 through the board manager, please use the development release link:
17+
18+
```
19+
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json
20+
```
21+
22+
Now you can install the latest 2.0.0 version from the boards manager.
1623

1724
### Development Status
1825

1926
Latest Stable Release [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)
2027

2128
Latest Development Release [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads-pre/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)
2229

30+
### Documentation
2331

24-
### Installation Instructions
25-
- Using Arduino IDE Boards Manager (preferred)
26-
+ [Instructions for Boards Manager](docs/arduino-ide/boards_manager.md)
27-
- Using Arduino IDE with the development repository
28-
+ [Instructions for Windows](docs/arduino-ide/windows.md)
29-
+ [Instructions for Mac](docs/arduino-ide/mac.md)
30-
+ [Instructions for Debian/Ubuntu Linux](docs/arduino-ide/debian_ubuntu.md)
31-
+ [Instructions for Fedora](docs/arduino-ide/fedora.md)
32-
+ [Instructions for openSUSE](docs/arduino-ide/opensuse.md)
33-
- [Using PlatformIO](docs/platformio.md)
34-
- [Building with make](docs/make.md)
35-
- [Using as ESP-IDF component](docs/esp-idf_component.md)
36-
- [Using OTAWebUpdater](docs/OTAWebUpdate/OTAWebUpdate.md)
32+
You can use [Arduino-ESP32 Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/docs-initial_version/index.html) to get all information about this project.
33+
34+
* [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/docs-initial_version/getting_started.html)
35+
* [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/docs-initial_version/installing.html)
36+
* [Libraries](https://docs.espressif.com/projects/arduino-esp32/en/docs-initial_version/libraries.html)
37+
* [ESP-IDF as Component](https://docs.espressif.com/projects/arduino-esp32/en/docs-initial_version/esp-idf_component.html)
38+
* [FAQ](https://docs.espressif.com/projects/arduino-esp32/en/docs-initial_version/faq.html)
39+
* [Troubleshooting](https://docs.espressif.com/projects/arduino-esp32/en/docs-initial_version/troubleshooting.html)
3740

3841
### Decoding exceptions
3942

@@ -42,16 +45,10 @@ You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecod
4245
### Issue/Bug report template
4346
Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labelled as [for reference](https://github.com/espressif/arduino-esp32/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3A%22for%20reference%22%20).
4447

45-
Finally, if you are sure no one else had the issue, follow the [ISSUE_TEMPLATE](docs/ISSUE_TEMPLATE.md) while reporting any issue.
46-
47-
### ESP32Dev Board PINMAP
48-
49-
![Pin Functions](docs/esp32_pinmap.png)
50-
51-
![ESP32S2_Pinmap](docs/esp32s2_pinmap.png)
48+
Finally, if you are sure no one else had the issue, follow the [issue template](docs/ISSUE_TEMPLATE.md) while reporting any issue.
5249

53-
![ESP32C3_Pinmap](docs/esp32c3_pinmap.png)
50+
### Contributing
5451

55-
### Tip
52+
We welcome contributions to the Arduino ESP32 project!
5653

57-
Sometimes to program ESP32 via serial you must keep GPIO0 LOW during the programming process
54+
See [contributing](https://docs.espressif.com/projects/arduino-esp32/en/docs-initial_version/contributing.html) in the documentation for more information on how to contribute to the project.

‎docs/Makefile

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
LINKCHECKDIR = build/linkcheck
12+
13+
.PHONY: checklinks
14+
checklinks:
15+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(LINKCHECKDIR)
16+
@echo
17+
@echo "Check finished. Report is in $(LINKCHECKDIR)."
18+
19+
# Put it first so that "make" without argument is like "make help".
20+
help:
21+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
22+
23+
.PHONY: help Makefile
24+
25+
# Catch-all target: route all unknown targets to Sphinx using the new
26+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
27+
%: Makefile
28+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/OTAWebUpdate/OTAWebUpdate.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

‎docs/arduino-ide/boards_manager.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/arduino-ide/debian_ubuntu.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎docs/arduino-ide/fedora.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎docs/arduino-ide/mac.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎docs/arduino-ide/opensuse.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎docs/arduino-ide/windows.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy