Marius Vikhammer
1a90470f02
doc: Split HW-Reference into seperate files/folders for different chips
2020-02-07 16:37:44 +11:00
Marius Vikhammer
d56ea52ea1
doc: EN doc update and fixed warnings
2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69
doc: Update English pages with generic target name
2020-02-07 16:37:43 +11:00
Angus Gratton
b0748b4364
docs: Mark some more docs sections as ESP32 only
2020-02-07 16:37:43 +11:00
Angus Gratton
9399f04da0
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs
2020-02-07 16:37:43 +11:00
Angus Gratton
37d5e2fba6
docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs
2020-02-07 16:37:43 +11:00
Angus Gratton
e6211c7864
docs: add new top-level docs builder that builds docs for a single chip
2020-02-07 16:37:43 +11:00
Konstantin Kondrashov
2c793cef06
idf: Support a custom toolchain with time_t wide 64-bits
...
Allows resolving the Y2K38 problem.
Closes: IDF-350
Closes: https://github.com/espressif/esp-idf/issues/584
2020-01-10 12:58:54 +08:00
Roland Dobai
bbbc12478a
Docs: Update Debian & Ubuntu install prerequisites
...
Latest versions of apt-get don't install as much packages by default
as older ones. This fix adds some missing packages discovered for an OS
derived from the latest stable Debian. These packages exist for older
Debian derivatives as well (tested with Ubuntu 16.04 LTS).
Closes https://github.com/espressif/esp-idf/issues/4480
2019-12-16 11:41:28 +01:00
Ivan Grokhotkov
f91c5c6f23
docs: update Windows tools installer link
2019-12-13 15:03:09 +01:00
Roland Dobai
105267d537
Doc: Remove menuconfig tool which is not used anymore
2019-11-28 10:07:49 +01:00
Roland Dobai
bd2fc9f832
Make menuconfig colors configurable
...
Closes https://github.com/espressif/esp-idf/issues/4387
2019-11-26 10:40:34 +01:00
Roland Dobai
01887f71e7
Update kconfiglib to upstream version and replace mconf-idf
...
Special thanks to @ulfalizer for the helpful suggestions regarding
kconfiglib.
"rsource" option is available for relative path includes
Closes https://github.com/espressif/esp-idf/issues/4064
2019-10-29 10:40:04 +01:00
Natasha
b0f2bb2adc
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
Ivan Grokhotkov
847537c862
docs: update get-started to use Tools Installer v2.1
2019-09-24 10:39:27 +02:00
Kondal Kolipaka
41a1eebbd4
docs: Update eclipse setup doc with the IDF Eclipse Plugins github link
2019-09-17 13:42:32 +05:30
joedeveloper
70b1ff7bc6
docs: Explain ncurses5 for other distributions as well
...
Ran into ncurses5 dependency issue on popOS
stub section for covering libncurses 5 workarounds on distributions that need it, when only Arch was
mentioned it was too easy to skip over the section
Merges https://github.com/espressif/esp-idf/pull/3236
2019-08-30 18:16:30 +10:00
Andrei Gramakov
79dd142ab8
tools: add install.ps1, export.ps1
...
Closes IDF-855
2019-08-27 13:45:50 +08:00
Krzysztof
164fd5ad29
More link corrections
2019-08-02 17:58:08 +08:00
Krzysztof
d163b9e615
Fix broken links in 'Getting Started' gudes
2019-08-02 17:09:33 +08:00
Kirill Chalov
639687f92b
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
Angus Gratton
80e9faaf1c
docs: Move Legacy Get Started guide to the Related Documents section
2019-07-09 20:35:34 +10:00
Angus Gratton
9583c8d037
docs: Rephrase the warning about not requiring MSYS2 on Windows
2019-07-09 14:32:26 +10:00
Angus Gratton
05ac8cfb6d
docs: Update description for Eclipse+Cmake support not ready yet
2019-07-09 14:32:26 +10:00
Angus Gratton
222146845c
docs: Make CMake build system default, mark GNU Make as legacy option
...
All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-07-09 14:32:26 +10:00
Angus Gratton
62ed221daf
docs: Functional renaming commit for CMake-as-default
...
Rename all the files which will be edited substantially in the next commit, without changing their
contents
Docs will not build for this ocmmit.
This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which
is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-07-08 17:31:27 +10:00
Wang Fang
b24341a664
Merge make-related documents:
...
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder;
2. Deleted get-started files, 7 documents in total, in get-started folder;
3. Updated links in get-started-cmake/index.rst and in get-started/index.rst;
4. Modified descriptions for build system in these files.
2019-07-04 13:16:18 +08:00
Ivan Grokhotkov
0e6ffd08b7
docs: update msys environment links for esp32-2019r1 toolchain
2019-06-11 22:22:14 +08:00
Krzysztof
4e95b1ad21
Provide getting started guide for 'ESP32-Ethernet-Kit' board
2019-06-06 15:45:45 +08:00
Natasha
440c42693d
Add translation for ESP32-WROVER-KIT Getting Started Guides
2019-05-27 07:53:20 +08:00
Alexey Gerenkov
8c6a924cdf
sys_view: Adds processing scripts for heap & log traces
2019-04-01 19:31:45 +03:00
liying
957301f293
add translation for devkitc guides and index files
2019-03-27 17:41:36 +00:00
Kirill Chalov
a1c39e4a53
Doc/review get st wrover kit
2019-03-26 16:12:42 +08:00
Kirill Chalov
bae824439e
Doc/review get st pico
2019-03-26 16:11:11 +08:00
Kirill Chalov
49cca9288f
Update IDF getting started sections for make and cmake as well as IDF monitor…
2019-03-14 00:10:26 +08:00
Roland Dobai
f0194f2a5e
docs: Update package dependencies
...
Closes https://github.com/espressif/esp-idf/issues/2384
2019-03-07 14:46:59 +01:00
Angus Gratton
aa4a5668b0
Merge branch 'bugfix/add_missing_links_to_translation' into 'master'
...
Included missing links between English and Chinese documentation, where…
See merge request idf/esp-idf!4176
2019-01-30 11:32:15 +08:00
Anton Maklakov
1332d3ba9c
docs: Correct priorities in the PATH string
...
Fixes https://github.com/espressif/esp-idf/pull/2944
2019-01-28 11:28:55 +08:00
krzychb
f675334ebb
Included missing links between English and Chinese documentation, where translation into Chinese is available
2019-01-27 19:01:34 +01:00
krzychb
7fa8eb91dd
Small updates of wording
2019-01-24 19:50:55 +08:00
ShellAddicted
aa364961d0
docs(en): dialout-linux added specific command for Arch linux the correct group is 'uucp'
...
Merges https://github.com/espressif/esp-idf/pull/2940
2019-01-24 19:50:55 +08:00
Angus Gratton
88150cb9bb
docs: Make Getting Started (CMake) guides version-aware
...
Also clean up some changes in Chinese CMake guide which were not propagated from the English guide.
2018-12-21 19:13:20 +11:00
krzychb
29b1f86f16
Extended information on using pins of ESP-WROVER-KIT that are shared among peripherals. Inspired by https://esp32.com/viewtopic.php?f=12&t=6856 .
2018-11-29 16:56:49 +01:00
Renz Christian Bagaporo
1600c3144c
docs: add pyparsing install to setup guide
2018-11-22 22:09:43 +08:00
Prasad Alatkar
b1189e9645
Docs: Change makes Eclipse setup inline with Mac OS and Linux.
2018-11-19 12:15:53 +08:00
Natasha
be0123e10e
Feature/update board guides for headers
2018-11-12 09:15:29 +08:00
Ivan Grokhotkov
c8fe9f696c
docs: fix instructions for building toolchain on macOS
...
Closes https://github.com/espressif/esp-idf/issues/503
Closes https://github.com/espressif/esp-idf/issues/2607
2018-10-26 12:42:38 +08:00
Angus Gratton
b964f389db
Merge branch 'bugfix/gcc8_compatibility' into 'master'
...
gcc8 compatibility for master branch
See merge request idf/esp-idf!3481
2018-10-22 11:11:04 +08:00
Krzysztof Budzynski
46c2112400
Added CN version of 'Getting Started' guides for 'ESP32-DevKitC' and 'ESP-WROVER-KIT'
2018-10-22 09:10:58 +08:00
Anton Maklakov
4a126e18ed
docs: Correct Linux port names for more relevance
2018-10-21 15:11:45 +08:00