798a174686
Add copyright check to pre-commit-config
2021-09-20 17:50:55 +08:00
7411321603
docs: update to use esp-docs
2021-08-24 08:56:48 +08:00
638485b222
docs: updated getting started and other misc. guides for S3
2021-06-29 15:44:45 +08:00
8149eda0a9
docs: introduce new rules for writing documents
2021-05-31 10:56:18 +08:00
89179dc286
docs: add fast build feature and activate it in CI
...
Adds feature for skipping include of doxygen headers into sphinx build
when env variable is set.
Builds incomplete docs (no function API documention)
but speeds up building (20min to 1<min).
Add this fast build as the default way of building docs in CI on
non protected branches.
2021-04-28 16:32:35 +08:00
c3101fff88
Merge branch 'docs/add_pre-commit_uninstall' into 'master'
...
Add line to documentation how to uninstall pre-commit.
See merge request espressif/esp-idf!13205
2021-04-23 08:09:36 +00:00
632b5c40e6
Revert "Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'"
...
This reverts merge request !13293
2021-04-23 13:44:40 +08:00
3e94dce15e
Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'
...
Doc: Sphinx uses the sphinx-reredirect extension
See merge request espressif/esp-idf!13293
2021-04-23 05:13:37 +00:00
2be772af1c
Sphinx uses reredirect extension
...
This commit removes the custom HTML rediiect extension and uses
the sphinx-reredirect extension instead. The sphinx-reredirect
extension allows for redirection to external links as well as
support for wildcards.
2021-04-23 00:02:30 +08:00
aebf688153
Add line to documentation how to uninstall pre-commit.
2021-04-20 03:53:54 +00:00
6a3971344b
docs: style guide: add note about header guards and include file order
2021-04-19 16:32:58 +02:00
15c3a42dcf
Merge branch 'doc/update_CN_translation_for_API_guides_and_Contribute' into 'master'
...
update CN translation for api-guides and contribute
See merge request espressif/esp-idf!12662
2021-03-23 08:05:28 +00:00
abb89b9a9c
docs: update CN translation for app_trace,linker-script-generation and add-ons-reference.rst
2021-03-23 11:24:23 +08:00
8ae944e26c
docs:update CN translation for documenting-code and LEDC
2021-03-23 10:52:50 +08:00
5e5e5c8753
[doc]: Corrected C3 LEDC docs
2021-03-03 16:49:05 +08:00
772b218c38
docs: Add section about assertions to the style guide
2021-03-03 10:31:05 +11:00
916f02164e
[doc]: NVS documentation updates
...
* Move nvs flash README to common doc directory
* correct markup of functions and types in text
from old README
* Better comment of nvs_get_used_entry_count()
* Mention C++ example in API reference
* Used target instead of hard code ESP32
* Note that strings can only span one page
* Reflect that item types have been moved
* Some clarification about nvs_commit()
* Improved reference to the ESP Partition API
* fixed little mistake in documenting-code.rst
* Change of nvs_open_from_part() to
nvs_open_from_partition() reflected in docs
* Corrected documentation of
NVSHandle::get_string(), NVSHandle::get_blob()
and NVSHandle::get_item_size().
* Closes DOC-165
* Closes IDF-1563
* Closes IDF-859
* Closes https://github.com/espressif/esp-idf/issues/6123
2021-02-08 09:31:23 +08:00
548fd02d10
docs: initial update of programming guide for C3
...
Updates "front page" content, get-started, and api-guides with C3 content
Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
da947d736f
Docs: Add C3 support to build_docs
2020-12-28 12:25:03 +08:00
7ab18c7571
Fix windows error by upgrading pre-commit-hook version.
...
drop python 2.7 support. Now we only support python 3.6.1+
2020-11-04 10:24:42 +08:00
e8dc27add2
add contributing docs
2020-11-03 18:33:11 +08:00
214c3a54b9
Doc/add chinese updates in contribute folder
2020-07-10 21:16:37 +08:00
a4d0033c03
esp_rom: extract common GPIO apis into esp_rom_gpio.h
2020-07-07 11:40:19 +08:00
ccdd3d3db8
docs: update sphinx_idf_theme documentation
...
Bump CI doc-env docker image to v5
2020-07-06 10:45:43 +08:00
3e57b1c180
doc: Added enum and typedef conventions
2020-06-01 14:41:43 +02:00
67ea59d605
docs: fix check_docs not working for multiple builders
...
When building docs with multiple builders the warning logs are now checked after
each run. Solves the issue where the logs would be overwritten by next builder before checking.
Closes IDF-1659
2020-05-29 20:10:18 +08:00
a316082f53
docs: support building a subset of the documentation with build_docs
...
Closes IDF-1688
2020-05-22 15:01:40 +08:00
7099c2b444
Merge branch 'doc/generate_idf_project_tags' into 'master'
...
doc: add generation of tags from sdkconfig and x_caps.h headers
Closes IDF-1484
See merge request espressif/esp-idf!8577
2020-05-20 23:46:47 +08:00
58a9db8492
Merge branch 'feature/smartconfig_links' into 'master'
...
Provide a brief description of SmartConfig and add link to example
See merge request espressif/esp-idf!8636
2020-05-18 01:02:05 +08:00
e58c0ac3e7
Provide a brief description of SmartConfig and add link to example
2020-05-18 01:02:04 +08:00
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
6d56ac8b84
docs: change descriptions of substitution defines to use literal blocks
...
Copy-pasting the "local substitution" example would result in an error,
due to the ASCII quotation marks being replaced by unicode double quotation marks
when outputting the HTML.
2020-05-12 11:32:34 +08:00
e7d92b857e
doc: roles for linking files now correctly links to submodule repositories
...
Closes IDF-1584
2020-04-20 15:59:41 +08:00
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
572ef008a9
Provide translation for the updates in 7637 and 8095, and correct a format issue in documenting-code
2020-03-29 16:50:40 +00:00
35560cb538
Merge branch 'doc/fix_example_links' into 'master'
...
doc: Fix invalid links
Closes DOC-67 and DOC-69
See merge request espressif/esp-idf!8065
2020-03-23 21:17:20 +08:00
52d888a68b
docs: Fix broken URLs & permanent redirects
2020-03-23 18:11:23 +11:00
5fbf95d691
docs: Expand the description of per-target custom macro directives
2020-03-20 19:57:18 +11:00
416076665b
docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer
2020-03-16 14:36:23 +11:00
9b56892bfe
doc: fix broken .. only:: in JTAG guide
...
Added note about .. only:: limitations to guide
2020-03-03 15:30:37 +08:00
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
63b76a9d90
doc: custom list filter directive
...
Custom directive that allows for creation of lists where the content can be filtered based on target.
Closes IDF-1385
2020-02-20 18:08:05 +08:00
291735c7dd
docs: Move to Python 3.5+ and Sphinx 2.3
2020-02-07 16:47:50 +11:00
4636e8a34c
docs/documenting-code: Add a couple of follow up notes on top of last commit
2020-02-07 16:37:45 +11:00
9f617c7874
docs: Add a short user guide for how to write multi target docs
2020-02-07 16:37:45 +11:00
50324b505d
docs: Note that the idf target formatting filters don't work on "included" documents
2020-02-07 16:37:45 +11:00
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
105567d077
doc: updated peripherals api-reference for s2
2020-02-07 16:37:44 +11:00
d56ea52ea1
doc: EN doc update and fixed warnings
2020-02-07 16:37:43 +11:00
9352899d69
doc: Update English pages with generic target name
2020-02-07 16:37:43 +11:00
Jan Brudný