Ivan Grokhotkov 3bbe41c34d Merge branch 'feature/docs_general_notes' into 'master' ...

Docs: new documentation and warnings cleanup

This change set

- adds a high-level description of application startup flow. Some parts are missing, but hopefully we can use this description as a base to expand on.
- adds a few notes about memory regions and their use in ESP-IDF.
- add SPI flash and partition APIs page
- fixes all Doxygen warnings in header files
- enables build failures on new Doxygen warnings

See merge request !201

2016-11-17 19:00:03 +08:00

..

_static

Guide on documenting code

2016-11-01 01:21:18 +08:00

api

docs: fix broken links, formatting, add SPI flash and partition APIs

2016-11-16 22:44:22 +08:00

security

docs: fix broken links, formatting, add SPI flash and partition APIs

2016-11-16 22:44:22 +08:00

build_system.rst

build system: Refactor SubmoduleCheck to work project-wide

2016-11-17 09:18:51 +11:00

conf.py

Conform Style Guide

2016-11-10 22:44:09 +01:00

contributing.rst

Link to file a folder up

2016-11-01 01:20:04 +08:00

contributor-agreement.rst

Fixed broken links

2016-11-05 17:04:35 +01:00

COPYRIGHT.rst

Initial list of Wi-Fi API

2016-11-01 01:20:04 +08:00

deep-sleep-stub.rst

Fixed section header style

2016-11-05 17:06:55 +01:00

documenting-code.rst

Instructions to prepare documentation

2016-11-05 17:19:31 +01:00

Doxyfile

docs: fix Doxygen warnings, fail CI build on Doxygen warnings

2016-11-16 22:44:22 +08:00

doxygen_xml_to_rst.xslt

docs: fix broken links, formatting, add SPI flash and partition APIs

2016-11-16 22:44:22 +08:00

eclipse-setup.rst

docs: fix typos, build docs with gitlab CI

2016-11-01 20:08:29 +08:00

esp32.cfg

Fix issued raised in the merge request

2016-08-30 11:30:03 +08:00

general-notes.rst

docs: fix broken links, formatting, add SPI flash and partition APIs

2016-11-16 22:44:22 +08:00

index.rst

docs: fix broken links, formatting, add SPI flash and partition APIs

2016-11-16 22:44:22 +08:00

linux-setup.rst

Initial list of Wi-Fi API

2016-11-01 01:20:04 +08:00

macos-setup.rst

Initial list of Wi-Fi API

2016-11-01 01:20:04 +08:00

make-project.rst

Make section

2016-11-01 01:20:04 +08:00

Makefile

Initial Sphinx / ReadTheDocs.org configuration

2016-11-01 01:20:04 +08:00

openocd.rst

Simplified "Installing OpenOCD" with git clone --recursive

2016-11-17 10:19:42 +11:00

partition-tables.rst

docs/nvs_flash: update the nvs flash offset comment according review

2016-11-17 11:44:39 +08:00

requirements.txt

docs: fix typos, build docs with gitlab CI

2016-11-01 20:08:29 +08:00

style-guide.rst

Fixed link so it can render by Sphinx

2016-11-10 22:44:59 +01:00

windows-setup.rst

Initial list of Wi-Fi API

2016-11-01 01:20:04 +08:00