Skip to content

Commit 39935b1

Browse files
committed
Doc - un-orphan FAQ and toctree inclusion
1 parent 2143c09 commit 39935b1

8 files changed

+27
-22
lines changed

doc/faq/readme.rst renamed to doc/faq.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This message indicates issue with uploading ESP module over a serial
2020
connection. There are couple of possible causes, that depend on the type
2121
of your module, if you use separate USB to serial converter.
2222

23-
`Read more <a01-upload-failed.rst>`__.
23+
`Read more <faq/a01-upload-failed.rst>`__.
2424

2525
Why esptool is not listed in "Programmer" menu? How do I upload ESP without it?
2626
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -38,7 +38,7 @@ My ESP crashes running some code. How to troubleshoot it?
3838
The code may crash because of s/w bug or issue with your h/w. Before
3939
entering an issue report, please perform initial troubleshooting.
4040

41-
`Read more <a02-my-esp-crashes.rst>`__.
41+
`Read more <faq/a02-my-esp-crashes.rst>`__.
4242

4343
How can I get some extra KBs in flash ?
4444
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -50,7 +50,7 @@ How can I get some extra KBs in flash ?
5050

5151
* Use the debug level option ``NoAssert-NDEBUG`` (in the Tools menu)
5252

53-
`Read more <a05-board-generator.rst>`__.
53+
`Read more <faq/a05-board-generator.rst>`__.
5454

5555
About WPS
5656
~~~~~~~~~
@@ -63,7 +63,7 @@ required to enable it:
6363

6464
``./tools/boards.txt.py --allowWPS --boardsgen``
6565

66-
`Read more <a05-board-generator.rst>`__.
66+
`Read more <faq/a05-board-generator.rst>`__.
6767

6868
For platformIO (and maybe other build environments), you will also need to add the build flag: -D NO_EXTRA_4K_HEAP
6969

@@ -77,7 +77,7 @@ This Arduino library doesn't work on ESP. How do I make it work?
7777
You would like to use this Arduino library with ESP8266 and it does not
7878
perform. It is not listed among libraries verified to work with ESP8266.
7979

80-
`Read more <a03-library-does-not-work.rst>`__.
80+
`Read more <faq/a03-library-does-not-work.rst>`__.
8181

8282
In the IDE, for ESP-12E that has 4M flash, I can choose 4M (1M FS) or 4M (3M FS). No matter what I select, the IDE tells me the maximum code space is about 1M. Where does my flash go?
8383
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -118,7 +118,7 @@ This error may pop up after switching between
118118
`staging <https://github.com/esp8266/Arduino#staging-version->`__ and
119119
`stable <https://github.com/esp8266/Arduino#stable-version->`__ esp8266
120120
/ Arduino package installations, or after upgrading the package version
121-
`Read more <a04-board-generic-is-unknown.rst>`__.
121+
`Read more <faq/a04-board-generic-is-unknown.rst>`__.
122122

123123

124124
How to clear TCP PCBs in time-wait state ?
@@ -199,4 +199,4 @@ By using a uniquely named `.h` file, macro definitions can be created and
199199
globally used. Additionally, compiler command-line options can be embedded in
200200
this file as a unique block comment.
201201

202-
`Read more <a06-global-build-options.rst>`__.
202+
`Read more <faq/a06-global-build-options.rst>`__.

doc/faq/a01-upload-failed.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
Why I am getting errors when trying to upload to my ESP?
42
--------------------------------------------------------
53

doc/faq/a02-my-esp-crashes.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
My ESP crashes running some code. How to troubleshoot it?
42
---------------------------------------------------------
53

doc/faq/a03-library-does-not-work.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
This Arduino library doesn't work on ESP. How do I make it working?
42
-------------------------------------------------------------------
53

doc/faq/a04-board-generic-is-unknown.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
How to resolve "Board generic (platform esp8266, package esp8266) is unknown" error?
42
------------------------------------------------------------------------------------
53

doc/faq/a05-board-generator.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
Board generator
42
---------------
53

doc/faq/a06-global-build-options.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
How to specify global build defines and options
42
===============================================
53

doc/index.rst

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
Welcome to ESP8266 Arduino Core's documentation!
22
================================================
33

4+
Using ESP8266 Core
5+
==================
6+
47
.. toctree::
58
:maxdepth: 2
6-
:caption: Contents:
79

810
Installing <installing>
911
Arduino IDE options <ideoptions>
@@ -15,11 +17,26 @@ Welcome to ESP8266 Arduino Core's documentation!
1517
PROGMEM <PROGMEM>
1618
Using GDB to debug <gdb>
1719
MMU <mmu>
18-
1920
Boards <boards>
20-
FAQ <faq/readme>
2121

22+
Troubleshooting
23+
===============
24+
.. toctree::
25+
:caption: Troubleshooting
26+
:maxdepth: 2
27+
28+
FAQ <faq>
2229
Exception causes <exception_causes>
2330
Debugging <Troubleshooting/debugging>
2431
Stack Dump <Troubleshooting/stack_dump>
2532
Using with Eclipse <eclipse/eclipse>
33+
34+
FAQ
35+
===
36+
.. toctree::
37+
:caption: FAQ
38+
:maxdepth: 2
39+
:titlesonly:
40+
:glob:
41+
42+
faq/*

0 commit comments

Comments
 (0)