pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Fix doc builds on Windows MINGW32, add some doc build documentation

Browse Source 
Using "find" doesn't work properly in MINGW32 Python, even if a MINGW32 find.exe
is on the PATH...
This commit is contained in:
Angus Gratton
2018-10-24 16:21:48 +11:00
committed by bot
parent 1e0ba34177
commit b47aca1175
2 changed files with 36 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+15
View File
@@ -14,3 +14,18 @@ Use actual documentation generated within about 20 minutes on each commit:
The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
# Building Documentation
* Install `make` and `doxygen` for your platform (`make` may already be installed as an ESP-IDF prerequisite).
* Change to either the docs/en or docs/zh_CN subdirectory and run `make html`
* `make` will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-run `make html` to build the docs.
## For MSYS2 MINGW32 on Windows
If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:
```
pacman -S doxygen mingw-w64-i686-python2-pillow
```
Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.