Commit graph

502 commits

Author SHA1 Message Date
Krzysztof
9c2ab4559d Fixed section header style
Please follow https://docs.python.org/devguide/documenting.html#sections
2016-11-05 17:06:55 +01:00
Krzysztof
b981b195be Fixed broken links 2016-11-05 17:04:35 +01:00
Ivan Grokhotkov
4d3ed9efde docs: update style guide 2016-11-03 19:07:41 +08:00
Ivan Grokhotkov
6602d6b7f2 docs: add style guide
This adds initial code style guide. Only section on code formatting is written, other sections to be added later.
Also adds scripts to format code using astyle.
2016-11-03 18:41:00 +08:00
Jeroen Domburg
3af7872839 Merge branch 'bugfix/small_fixes' into 'master'
OpenOCD doc fix, fix gdbstub

- Fixes a few typos in the OpenOCD docs
- Fix compiling with gdbstub as panic handler

See merge request !165
2016-11-02 10:27:26 +08:00
Jeroen Domburg
d0fac3c395 Language tweaking 2016-11-02 10:26:02 +08:00
Angus Gratton
04beb8baba Add documentation for bootloader secure boot stage 2016-11-02 10:41:59 +11:00
Ivan Grokhotkov
f18c1f13b1 Merge branch 'feature/deepsleep_stub_linker' into 'master'
Deep sleep: Any source named rtc_wake_stub* is linked as RTC wake stub code

Also move esp_deepsleep.h documentation out to docs/deep-sleep-stub.rst

See merge request !142
2016-11-01 22:27:13 +08:00
Ivan Grokhotkov
4f71d741ec docs: deploy built docs 2016-11-01 22:21:46 +08:00
Ivan Grokhotkov
1d3626c119 docs: fix typos, build docs with gitlab CI 2016-11-01 20:08:29 +08:00
Jeroen Domburg
8c1d1e19c2 OpenOCD doc fix, fix gdbstub 2016-11-01 15:41:10 +08:00
Krzysztof
73944e6800 Typo corrections 2016-11-01 01:21:18 +08:00
Krzysztof
d66f05c61b Guide on documenting code 2016-11-01 01:21:18 +08:00
Krzysztof
19af5b7a76 Changed title of docs 2016-11-01 01:21:18 +08:00
Krzysztof
079f5faad8 Fixed confused Sphinx
Sphinx failed to phrase esp_log_timestamp
reorderdering esp_log_write and esp_log_timestamp fixed this issue
2016-11-01 01:21:18 +08:00
Krzysztof
905d27815c API samples
- Logging library
- Virtual file system component
2016-11-01 01:21:18 +08:00
Krzysztof
234739f51a Draft of non-volatile storage component documentation 2016-11-01 01:20:04 +08:00
Krzysztof
f05cd619f4 Sample cleaning of markup 2016-11-01 01:20:04 +08:00
Krzysztof
adae42fd85 API template
- reflected template in other DRAFT API dcouments
- DRAFT of Bluetooth API
- link fixes in CONTRIBUTING.rst
2016-11-01 01:20:04 +08:00
Krzysztof
3584fcfc7c Make section 2016-11-01 01:20:04 +08:00
krzychb
b6a463e94f Draft of GPIO API included 2016-11-01 01:20:04 +08:00
Krzysztof
8ae97a2855 Initial list of Wi-Fi API 2016-11-01 01:20:04 +08:00
Krzysztof
6ce1af5898 Set up of theme for local builds 2016-11-01 01:20:04 +08:00
Krzysztof
6435a71de2 Reduced the build coverage by DoxyGen 2016-11-01 01:20:04 +08:00
Krzysztof
cb70ac831f Increased buikd coverage of DoxyGen 2016-11-01 01:20:04 +08:00
Krzysztof
99fc760088 Link to file a folder up 2016-11-01 01:20:04 +08:00
Krzysztof
ec99397c3e Initial Sphinx / ReadTheDocs.org configuration 2016-11-01 01:20:04 +08:00
Angus Gratton
da70611196 Deep sleep: Any source named rtc_wake_stub* is linked as RTC wake stub code
Also move esp_deepsleep.h documentation out to docs/deep-sleep-stub.rst
2016-10-19 15:58:37 +11:00
Angus Gratton
a98ab8d801 nvs: Remove flash layout arguments from nvs_init()
Add notes that current NVS layout defaults are a Work In Progress and
not yet integrated with the partition table.
2016-09-27 13:28:45 +10:00
Angus Gratton
12b09344c8 Add contributor agreement, update CONTRIBUTING file 2016-09-27 12:06:54 +10:00
Angus Gratton
6cf5d44b31 build system docs: Add note about no spaces in component names 2016-09-16 18:22:16 +10:00
Angus Gratton
90017397e5 Docs: Add note about unusual submodule messages when cloning on Windows
Related to github #11
2016-09-16 18:07:58 +10:00
Angus Gratton
567cabb3f5 docs: Add note about esp-idf not supporting spaces in paths
Ref Github #10
2016-09-16 18:07:58 +10:00
Angus Gratton
7c58c1e06b Build system: Allow components to add to the global CFLAGS via Makefile.projbuild
Used by mbedTLS to set MBEDTLS_CONFIG_FILE in all components.

This change sets CFLAGS/etc at the project level and then exports those
variables for components, rather than setting them independently each time
a component Makefile is invoked.
2016-09-09 11:08:19 +10:00
Angus Gratton
1d8eece834 Rename README.buildenv to docs/build_system.rst and ReST-ify it 2016-09-08 13:41:19 +10:00
Angus Gratton
c50f7aa07b Eclipse docs: Easier to just replace entire PATH, msys32 has everything we need to build/flash 2016-09-08 13:41:19 +10:00
Angus Gratton
71785378bc Eclipse doc: Add troubleshooting note about Makefile directories 2016-09-08 13:39:09 +10:00
Angus Gratton
144ebe5d53 Move bin/eclipse_windows_make.sh to tools/windows_eclipse_make.sh
Moving as bin directory is going away soon
2016-09-08 13:39:09 +10:00
Angus Gratton
2ddd05a3fa Eclipse docs: Prepend IDF paths to beginning of PATH
Avoids problem when a different incompatible make (MSYS1 or other) is already on PATH.
2016-09-08 13:39:09 +10:00
Jeroen Domburg
69f7bf5235 Add bit of text saying openocd helper options for esp-idf are enabled by default 2016-08-30 15:44:20 +08:00
Jeroen Domburg
6858d2993f Fix issued raised in the merge request 2016-08-30 11:30:03 +08:00
Jeroen Domburg
16956f6474 Add openocd documentation and config file 2016-08-29 16:24:22 +08:00
Ivan Grokhotkov
2ee17ef950 docs: update linux getting started guide
- add commands to get prerequisites on Debian and Arch
- change "Terminal.app" to "terminal"
- add note on python2 for Arch users
2016-08-24 11:17:15 +08:00
Ivan Grokhotkov
57f0b96eea docs: add linux getting started guide
Currently this is mostly a verbatim copy of macOS guide with some obvious changes.
Exact lists of dependencies for Debian and Arch need to be specified.
Also made minor fixes to Windows and macOS guides:
- changed http urls to https
- added --prefix=$PWD to crosstool-NG's configure
- added chmod u+w for the build output directory

In general, except for prerequisites, Linux and macOS guides are virtually identical.
It might make sense to refactor this into single document with prerequisites being
described in separate docs.
2016-08-23 17:25:32 +08:00
Ivan Grokhotkov
00eed0deed docs: macOS update started guide
fix URL to use HTTPS
fix typo
mention that compiling toolchain is optional
mention how to find the serial port
2016-08-23 10:38:05 +08:00
Ivan Grokhotkov
ad90dd81a6 docs: add setup guide for macOS 2016-08-22 19:35:31 +08:00
Angus Gratton
f853f94335 Use IDF_PATH instead of SDK_PATH for the environment variable pointing to esp-idf
This will require a matching change in all projects using ESP-IDF.
2016-08-19 15:01:49 +08:00
Angus Gratton
9ec0e1545d Standardise remaining uses of SDK to ESP-IDF 2016-08-19 15:01:15 +08:00
Angus Gratton
ceafd59d91 Windows-setup: Remove direct download option as it doesn't work 2016-08-19 15:01:14 +08:00
Angus Gratton
73001bcda2 Move details about partition tables to their own ReST doc in docs/ 2016-08-18 21:42:37 +08:00
Angus Gratton
df4eeac5a2 Fix documentation errors/typos 2016-08-18 21:42:37 +08:00
Ivan Grokhotkov
bd6ea4393c Initial public version 2016-08-17 23:08:22 +08:00