Docs: Initial documentation structure using Sphinx #5355
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pedrominatel
added
the
Type: Documentation
|
PTAL @me-no-dev and let me know if any other change is required. |
|
Can we move |
pedrominatel
commented
Jul 14, 2021
There was a problem hiding this comment.
Can we move
InstallingandBoardssections underGetting Started? Add a section named such asAdvanced Utilities, and moveLibrary Builder,ESP-IDF as Component,OTA Web Update,makeEspArduinoinside. So the CONTENTS will be concise.
I just think we should keep Library Builder and ESP-IDF as Component as is because both are often used. We can move them to Advanced Utilities when the content index gets bigger.
aIecxs
pushed a commit
to aIecxs/arduino-esp32
that referenced
this pull request
Oct 24, 2024
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the initial documentation structure including the basic information about the project and Sphinx configuration.
CONTENTS:
This PR also changes the README.md.