Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs
History
Angus Gratton 3350a108c3 build system: Also get IDF version from annotated tags only 
Builds on previous commit.

Note: Getting the project version still pases --tags so still works with plain
tags, to keep compatibility for existing projects
2020-10-07 13:55:53 +11:00
..
_static ble_mesh: Doc miscellaneous fixes 2020-05-21 17:48:21 +08:00
en build system: Also get IDF version from annotated tags only 2020-10-07 13:55:53 +11:00
zh_CN build system: Also get IDF version from annotated tags only 2020-10-07 13:55:53 +11:00
check_doc_warnings.sh docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs. 2019-02-27 22:11:59 +01:00
check_lang_folder_sync.sh Revert "docs: Temporarily allow cmake docs to be in English only" 2018-05-07 18:45:49 +08:00
conf_common.py tools: fix python lint 2020-06-24 13:22:21 +08:00
docs_common.mk docs: Add ESP-IDF support period policy 2019-10-29 16:26:13 +11:00
Doxyfile Merge branch 'doc/add_ble_mesh_doxyfile' into 'master' 2019-07-05 20:55:39 +08:00
gen-dxd.py docs: Correct Python coding style 2018-12-05 08:22:33 +01:00
gen-toolchain-links.py Introduce esp-2019r2 toolchain 2019-11-04 16:21:56 +07:00
gen-version-specific-includes.py build system: Also get IDF version from annotated tags only 2020-10-07 13:55:53 +11:00
html_redirects.py docs: Add option to redirect documentation pages which have moved 2018-12-18 14:07:43 +11:00
issue_template.md build system: Also get IDF version from annotated tags only 2020-10-07 13:55:53 +11:00
link-roles.py docs: Correct Python coding style 2018-12-05 08:22:33 +01:00
local_util.py Download font file only is not exists in target location 2019-05-21 09:51:39 +08:00
page_redirects.txt docs: Update description for Eclipse+Cmake support not ready yet 2019-07-09 14:32:26 +10:00
README.md doc: Fix doc builds on Windows MINGW32, add some doc build documentation 2018-10-26 04:04:56 +00:00
requirements.txt Docs: Fix sphinxcontrib dependencies 2020-02-14 10:39:19 +01:00
sphinx-known-warnings.txt docs: Make CMake build system default, mark GNU Make as legacy option 2019-07-09 14:32:26 +10:00
TEMPLATE_EXAMPLE_README.md build system: Use CMake-based build system as default when describing commands 2019-07-08 17:31:27 +10:00

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation available in English and 中文.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated within about 20 minutes on each commit:

Hosted Documentation

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.