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
Angus Gratton
783856d557
docs: Move Doxygen build to a Sphinx extension, load sdkconfig & soc caps headers
2020-02-07 16:37:12 +11:00
Angus Gratton
fcf76320c8
docs: Start refactoring IDF-specific docs features into extensions
...
Run the actual IDF build system to determine what components are linked
for a particular target.
2020-02-07 16:37:12 +11:00
Roland Dobai
5454c268f7
Docs: Omit kconfig configurations not available for the target
2020-01-30 10:30:06 +01:00
Ivan Grokhotkov
1cd6f67679
docs: add API guide page about IDF Tools
2020-01-24 14:02:21 +01:00
morris
e30cd361a8
global: rename esp32s2beta to esp32s2
2020-01-22 12:14:38 +08:00
Roland Dobai
84d5cc1c17
Generate source files for kconfiglib from the build system
2019-11-15 15:25:09 +00: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
Angus Gratton
438d513a95
Merge branch 'master' into feature/esp32s2beta_merge
2019-09-16 16:18:48 +10:00
Angus Gratton
49698e15f3
docs: Don't build any docs for the esp32s2beta component
...
Re-enable failing CI for warnings in the docs build
This config hack can be removed once IDF-523 is implemented.
2019-09-13 14:08:21 +10:00
Kirill Chalov
7c491d2335
Allow the extension for adding todo notes to rst files. Add information on how to use this extension to the contribution section.
2019-09-11 17:15:00 +08:00
Roland Dobai
bd21960955
tools: Support sdkconfig.rename files from outside IDF in confgen.py
2019-07-16 20:18:19 +02:00
Angus Gratton
86dbe9299a
docs: Load page redirects from a file instead of inline in config
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
Krzysztof
754a454402
Introduce separate fonts used by blockdiag, sequdiag, actdiag, nwdiag, rackdiag and packetdiag for Chinese and English version of documentation
2019-05-06 13:19:58 +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
Renz Christian Bagaporo
1177427aac
docs: remove invalid arg in confgen invocation on docs generation
2019-01-16 08:16:09 +08:00
Renz Christian Bagaporo
7254476acb
docs: list kconfig components alphabetically via component name
2018-12-20 19:57:46 +08:00
Angus Gratton
b240a181b7
docs: Add option to redirect documentation pages which have moved
2018-12-18 14:07:43 +11:00
Roland Dobai
b56ed1a99e
docs: Correct Python coding style
2018-12-05 08:22:33 +01:00
Angus Gratton
c0298a5712
Merge branch 'bugfix/doc_builds_windows' into 'master'
...
doc: Fix doc builds on Windows MINGW32, add some doc build documentation
See merge request idf/esp-idf!3550
2018-11-20 17:20:40 +08:00
Angus Gratton
b47aca1175
doc: Fix doc builds on Windows MINGW32, add some doc build documentation
...
Using "find" doesn't work properly in MINGW32 Python, even if a MINGW32 find.exe
is on the PATH...
2018-10-26 04:04:56 +00:00
Roland Dobai
9daf51e6be
Fix Python 3 compatibility issues
2018-10-24 11:20:54 +02:00
Anurag Kar
2d199dc521
Docs : Added Provisioning and Protocomm related docs
...
Co-Authored-By: Amey Inamdar <amey@espressif.com>
Co-Authored-By: Anurag Kar <anurag.kar@espressif.com>
2018-10-02 19:07:28 +05:30
Ivan Grokhotkov
e1ac237169
Merge branch 'doc/fix_config_links' into 'master'
...
doc: Fix config links, add navigation lists to config items page
See merge request idf/esp-idf!3310
2018-09-25 18:23:24 +08:00
Angus Gratton
688807d5f6
docs: Don't show Kconfig.projbuild from MQTT submodule examples in docs
2018-09-21 11:05:16 +10:00
Ivan Grokhotkov
91fa1764e5
docs: generate toolchain download links
2018-09-20 18:53:14 +08:00
Angus Gratton
44e4535c90
docs: Set a default IDF_PATH in docs build (needed for RTD)
...
RTD builds don't set IDF_PATH, mqtt component uses this variable.
2018-09-14 09:42:57 +10:00
Roland Dobai
f5a642840a
docs: Make the Python scripts Python 2&3 compatible
2018-09-10 08:37:43 +02:00
Angus Gratton
0bc5dcc2c2
cmake: Post-merge fixups
2018-09-06 11:14:30 +08:00
Angus Gratton
b355854d4d
Merge branch 'master' into feature/cmake
2018-09-05 10:35:04 +08:00
Roland Dobai
7cfef29eb8
Docs: Check Python packages
2018-08-30 13:20:42 +02:00
Angus Gratton
ff2404a272
Merge branch 'master' into feature/cmake
2018-08-16 17:14:17 +10:00
Ivan Grokhotkov
73e18a4c96
Merge branch 'docs/simplified_rtd_theme_configuration' into 'master'
...
Removed redundant code to configure 'sphinx-rtd-theme' for documentation
See merge request idf/esp-idf!2921
2018-08-16 05:23:54 +08:00
Angus Gratton
04238fa5e5
docs: Python 3 Sphinx compatibility
2018-08-13 15:37:03 +10:00
Angus Gratton
69f73eb5ee
docs: Move version-related includes to run in sphinx-build not make
...
Means they show up on ReadTheDocs(!)
2018-08-13 12:24:55 +10:00
krzychb
df9c701864
Removed redundant code to configure 'sphinx-rtd-theme' for documentation
2018-08-02 22:10:33 +02:00
krzychb
c7ab37143b
Logo version 8, vector graphics and a new typeface
2018-07-23 19:18:50 +02:00
krzychb
da86681f21
Added Espressif logo to documentation
2018-07-18 07:03:00 +02:00
Ivan Grokhotkov
8c87df538e
docs: conf.py: check return code when calling os.system
...
Several calls were made but results were not checked, obfuscating the
errors.
2018-06-21 15:22:56 +08:00
Ivan Grokhotkov
d9f8311b9d
docs: add error codes reference
2018-06-15 15:49:24 +08:00
Angus Gratton
6b9784cc45
Merge branch 'master' into feature/cmake_update
2018-05-31 14:46:23 +10:00
Ivan Grokhotkov
e3a5974651
docs: make conf.py python3 compatible
2018-05-04 02:31:57 +08:00
Angus Gratton
2a3e2b8eed
doc: Use confgen.py to build docs from same code path as config generation
2018-04-30 09:59:20 +10:00
krzychb
43fb8033ec
ReadTheDocs theme has an annoying bug of text not being wrapped inside table cells. Each row is extended to fit the text as a single line. For a table with multiple columns and long sentences the table may get wide, with long scrollbar underneath and is not convenient to read. This MR makes the text wrap inside table cells. There is an open PR to fix this issue - https://github.com/rtfd/sphinx_rtd_theme/pull/432 .
2018-04-09 05:47:36 +02:00
Angus Gratton
748fef4363
doc: Move non-language-specific RTD/Sphinx config to conf_common.py
2018-03-16 12:00:01 +11:00
