espressif/arduino-esp32
1
0
Fork 1
mirror of https://github.com/0xFEEDC0DE64/arduino-esp32.git synced 2025-07-30 02:37:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

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
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/source/index.rst Normal file
View File

@ -0,0 +1,20 @@
#############################################
Welcome to ESP32 Arduino Core's documentation
#############################################
Here you will find all the relevant information about the project.
.. note::
This is a work in progress documentation and we will appreciate your help! We are looking for contributors!
.. toctree::
:maxdepth: 2
:caption: Contents:
Getting Started <getting_started>
Libraries <libraries>
Tutorials <tutorials/tutorials>
Advanced Utilities <advanced_utils>
FAQ <faq>
Troubleshooting <troubleshooting>
Contributing <contributing>