Commit Graph

102 Commits

Author SHA1 Message Date
Fu Hanxi
22a8784553 docs: fix 404 links 2023-06-06 11:11:23 +08:00
Zim Kalinowski
7558a0933d docs: updated contribution agreement 2023-04-20 11:07:25 +02:00
Jakob Hasse
3839508bf6 doc: made reasonable exception for CamelCase explicit 2023-03-24 12:01:38 +08:00
Fu Hanxi
953d1fcbca docs: provide simple approach to run pytest locally 2023-03-10 11:25:02 +08:00
Roland Dobai
1dc3d5ef22 Merge branch 'feature/introduce_spdx_licenseref' into 'master'
tools: allow to use LicenseRef-[idstring] in SPDX-License-Identifier

Closes IDF-4486

See merge request espressif/esp-idf!22132
2023-02-10 17:08:01 +08:00
laokaiyao
f27cd67c00 driver: pack peripherals 2023-02-02 18:19:58 +08:00
Frantisek Hrbata
8e893db5f3 docs: allow to use SPDX LicenseRef-[idstring] indentifier
In a very rare cases there is a need to use custom license, which is not
present on the SPDX list. Now, files under such license are added to the
check_copyright ignore list. For example zigbee examples introduced
by !16205. SPDX has a LicenseRef-[idstring] identifier[1] for such cases,
so let's try to use it in license representation[2]. The idea is that licenses
not on the SPDX list can be added into the LICENSES[3] directory and used as

	SPDX-License-Identifier: LicenseRef-Special-License

Or if the custom license is present directly in a source file we can use
a special LicenseRef-Included identifier to state that the license
is included.

	SPDX-License-Identifier: LicenseRef-Included

Please note that LicenseRef-Included is just a made up identifier to
state the fact that the license is included directly in the source file.
There is nothing in the SPDX spec about this usage.

This relatively small adjustment allows to refer to custom licenses
without a need to skip check_copyright for them.

[1] https://spdx.github.io/spdx-spec/v2.3/other-licensing-information-detected/#101-license-identifier-field
[2] https://spdx.github.io/spdx-spec/v2.3/using-SPDX-short-identifiers-in-source-files/#e4-representing-multiple-licenses
[3] https://reuse.software/spec/

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-02-02 08:21:47 +01:00
Fu Hanxi
407cdd2a14 docs: add performance related functions 2022-12-21 10:26:19 +08:00
Fu Hanxi
c3c48b95da docs: fix the current doc section level and outdated content 2022-12-21 10:25:33 +08:00
Fu Hanxi
df63cd0765 docs: update pytest related docs 2022-12-08 09:49:12 +08:00
Marius Vikhammer
0244c81fd2 docs: update getting started and frontpage docs for C6 2022-11-17 11:30:30 +08:00
Darian Leung
4b2c8c591b freertos: Add uncrustiy config files for IDF FreeRTOS v10.4.3
This commit adds a copy of upstream vanilla FreeRTOS uncrustify.cfg files from
the following upstream commit:

89e4823a49

Note: "pp_indent_brace" is commented out as that was enabled after v10.4.3

Also also added a note in the ESP-IDF style guide aobut formatting FreeRTOS
source code using Uncrustify.
2022-11-02 19:42:19 +08:00
Tomas Rezucha
c6fbefcd84 usb_host: Remove custom test_app 2022-09-05 20:14:56 +02:00
Fu Hanxi
8e9cdb0770 docs: improve ci related docs 2022-07-22 08:18:19 +08:00
Fu Hanxi
05d2357062 feat: use standalone project idf-build-apps for find/build apps utils 2022-07-14 08:26:31 +08:00
Fu Hanxi
566af729c5 docs: update pytest installation 2022-06-08 08:19:35 +08:00
Marius Vikhammer
030e52f5d4 Merge branch 'feature/improve_doc_link_check' into 'master'
docs: fix broken links and re-enable linkchecker

Closes IDF-2640

See merge request espressif/esp-idf!17919
2022-05-19 15:52:17 +08:00
Fu Hanxi
3697cd0440 docs: add multi dut chapter 2022-05-13 11:56:59 +08:00
Marius Vikhammer
030cb77597 docs: update redirected links 2022-05-07 13:09:41 +08:00
Ivan Grokhotkov
0f515ce3fb
docs: make CONTRIBUTING.md readable on Github
Move the contents of CONTRIBUTING.rst into contributing/index.rst,
create CONTRIBUTING.md with a link to the programming guide.

Closes https://github.com/espressif/esp-idf/issues/6807
2022-05-04 01:16:34 +02:00
Fu Hanxi
79bde140c3 ci: improve pytest doc 2022-03-10 14:37:13 +08:00
Fu Hanxi
5ccb5eeebd docs: add README about pytest in IDF 2022-03-03 14:36:50 +08:00
Tomas Sebestik
fb12d03dc3 Drop Python 3.6 2022-02-10 07:20:52 +01:00
Marius Vikhammer
93430c9eab docs: update copyright date for docs automatically 2022-01-10 15:05:33 +08:00
Marius Vikhammer
5f7733f692 docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00
Roland Dobai
513a9b18a3 Docs: Update the copyright contribution guide with new options of the checker
Document additional options introduced by 228113a399.
2021-12-08 12:17:24 +01:00
Roland Dobai
a1d0d1ffbe Tools: Remove MSYS/Mingw support
MSYS/Mingw was deprecated since v4.0 and it is removed in v5.0. Please
follow the getting started guide of the documentation to set up a
Windows Command Line or Power Shell based environment.
2021-11-10 17:25:07 +01:00
Roland Dobai
9c1d4f5b54 Build & config: Remove the "make" build system
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
Roland Dobai
4d149f070c Docs: Add copyright header guide for contributions 2021-11-04 11:55:26 +01:00
Jan Brudný
798a174686 Add copyright check to pre-commit-config 2021-09-20 17:50:55 +08:00
Marius Vikhammer
7411321603 docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
Marius Vikhammer
638485b222 docs: updated getting started and other misc. guides for S3 2021-06-29 15:44:45 +08:00
daiziyan
8149eda0a9 docs: introduce new rules for writing documents 2021-05-31 10:56:18 +08:00
Marius Vikhammer
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
Angus Gratton
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
Krzysztof Budzynski
632b5c40e6 Revert "Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'"
This reverts merge request !13293
2021-04-23 13:44:40 +08:00
Krzysztof Budzynski
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
Darian Leung
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
Dmitry
aebf688153 Add line to documentation how to uninstall pre-commit. 2021-04-20 03:53:54 +00:00
Ivan Grokhotkov
6a3971344b docs: style guide: add note about header guards and include file order 2021-04-19 16:32:58 +02:00
Krzysztof Budzynski
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
daiziyan
abb89b9a9c docs: update CN translation for app_trace,linker-script-generation and add-ons-reference.rst 2021-03-23 11:24:23 +08:00
Dai Zi Yan
8ae944e26c docs:update CN translation for documenting-code and LEDC 2021-03-23 10:52:50 +08:00
Jakob Hasse
5e5e5c8753 [doc]: Corrected C3 LEDC docs 2021-03-03 16:49:05 +08:00
Angus Gratton
772b218c38 docs: Add section about assertions to the style guide 2021-03-03 10:31:05 +11:00
Jakob Hasse
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
Marius Vikhammer
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
Marius Vikhammer
da947d736f Docs: Add C3 support to build_docs 2020-12-28 12:25:03 +08:00
Fu Hanxi
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
Fu Hanxi
e8dc27add2 add contributing docs 2020-11-03 18:33:11 +08:00