Angus Gratton
a171def1ba
docs: Redirect all of Doxygen stderr to the warnings log
...
Some errors (for example the errors caused by macro values, as fixed in previous
commit) get logged to stderr even if WARN_LOGFILE is set, but Doxygen succeeds.
2020-06-12 14:30:47 +10:00
Angus Gratton
ea9322937f
docs: Log the full list of macros, remove code-style macros to prevent Doxygen errors
2020-06-12 14:30:47 +10:00
Angus Gratton
7d989e08fd
doc: Fix passing of build macros to Doxygen
...
Regression in fbb54184ef
, the dictionary
passed to generate_doxygen function was still the project_description
structure.
2020-06-12 14:30:47 +10:00
Krzysztof Budzynski
fa0dd5cc7b
Merge branch 'doc/view_github_link' into 'master'
...
docs: add 'edit-on-github' link to html theme
Closes IDF-1504
See merge request espressif/esp-idf!8629
2020-05-25 03:21:23 +08:00
Marius Vikhammer
a316082f53
docs: support building a subset of the documentation with build_docs
...
Closes IDF-1688
2020-05-22 15:01:40 +08:00
Anton Maklakov
e1262aa68e
Merge branch 'bugfix/gh_action_pass_IDF_PATH_to_pylint' into 'master'
...
gh_action: fix python lint
Closes IDF-1538 and IDFGH-3341
See merge request espressif/esp-idf!8812
2020-05-21 10:15:35 +08:00
morris
d003f96a9d
gh_action: fix python lint
2020-05-20 10:50:10 +08:00
Marius Vikhammer
fbb54184ef
doc: add generation of tags from sdkconfig and x_caps.h headers
...
Also updates the way we handle exclude_patterns to use the new tags
Closes IDF-1484
2020-05-13 07:09:01 +00:00
Marius Vikhammer
214f1fbbed
docs: add 'edit-on-github' link to html theme
...
Closes IDF-1504
2020-05-06 17:25:23 +08:00
Marius Vikhammer
dc2c753a7d
doc: remove links to translation if building PDF
...
Closes IDF-1579
2020-04-23 18:59:37 +08:00
Marius Vikhammer
e7d92b857e
doc: roles for linking files now correctly links to submodule repositories
...
Closes IDF-1584
2020-04-20 15:59:41 +08:00
Marius Vikhammer
407275f681
doc: add latex and PDF generation to build_docs
...
Adds options for generating tex-files and PDFs when building documentation
Closes IDF-1217
Closes IDF-1464
2020-04-15 17:14:22 +08:00
morris
17b90afcab
doc: fix defines dict expansion
2020-03-30 18:26:37 +08:00
Wang Fang
d10e24fb94
Update toolchain xtensa-esp-elf to xtensa-esp32-elf by modifying the dict TOOLCHAIN_NAMES
2020-03-26 18:15:37 +08:00
morris
b5ab764f82
doc: correct soc caps file path
2020-03-24 19:11:28 +08:00
Angus Gratton
a6b522c0f4
docs: Fix generation of links to examples
2020-03-23 18:11:23 +11:00
Angus Gratton
296a1db3c6
docs: Update link_to_translation to work with targets & new URL scheme
...
Main difference is using app config for version & target
Also made this code less generic, easier to understand
2020-03-16 14:36:23 +11:00
Marius Vikhammer
dfc95bc78b
docs: multi target include dir support
...
Closes IDF-1371
Added an include directive that allows for the content to be formatted
according to idf target
2020-03-03 11:37:42 +08:00
Angus Gratton
a825985283
docs: Check local files exist (and are correct type) for custom link roles
2020-02-18 10:34:11 +11:00
Supreet Deshpande
ef7b5ff9e4
bugfix/build_docs_add_warning_check: Added null value check for warnings
2020-02-12 12:32:41 +05:30
Angus Gratton
2c03d2cc4e
docs: Re-run the 'set-target' target each time, use a unique sdkconfig file for each lang/target combo
...
Fixes some problems with CMake errors in stale builds, and of sdkconfig file being shared between
parallel jobs.
2020-02-07 16:47:50 +11:00
Angus Gratton
291735c7dd
docs: Move to Python 3.5+ and Sphinx 2.3
2020-02-07 16:47:50 +11:00
Angus Gratton
d03af45731
docs: flake8 fixes
2020-02-07 16:37:45 +11:00
Anton Maklakov
775448c792
docs: Make Python 3 compatible
2020-02-07 16:37:45 +11:00
Marius Vikhammer
268816649c
Replace all TRM urls will generic template variable and remove duplicate sections
...
All references to TRM had the section duplicated for both targets using .. only:: , replaced these with a generic template url
2020-02-07 16:37:45 +11:00
Angus Gratton
35db219be2
docs: Manage parallel sphinx-build runs with optional parallel jobs within them
2020-02-07 16:37:44 +11:00
Marius Vikhammer
83521dbc51
doc: Include paths for chip specific headers now depend on target
...
Input for Doxygen now depend on idf_target for some paths, updated path name generated in run_doxygen.py to show the target dependent path.
2020-02-07 16:37:44 +11:00
Marius Vikhammer
c848aa74ac
doc: Add extension that replaces generic target variable with idf_target
...
Also changed event trigger for idf-extension to use config-updated, as this makes more logical sense
Includes functionality for defining local (single .rst file) substitution strings that depend on chip target.
Substitutions can be defined with {IDF_TARGET_X: default = "IO3", esp32 = "IO4"} and then used locally as {IDF_TARGET_X}
Also added global substitution for TRM links {IDF_TARGET_TRM_URL}
2020-02-07 16:37:43 +11:00
Angus Gratton
a148d8e6ba
docs: Refactor extensions into packages, update the add-ons-reference docs page
...
Includes converting some of the remaining standalone scripts into Sphinx extensions.
Make flake8 clean
2020-02-07 16:37:43 +11:00