Commit Graph

83 Commits

Author SHA1 Message Date
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
Hao Ning
214c3a54b9 Doc/add chinese updates in contribute folder 2020-07-10 21:16:37 +08:00
morris
a4d0033c03 esp_rom: extract common GPIO apis into esp_rom_gpio.h 2020-07-07 11:40:19 +08:00
Marius Vikhammer
ccdd3d3db8 docs: update sphinx_idf_theme documentation
Bump CI doc-env docker image to v5
2020-07-06 10:45:43 +08:00
Andrei Gramakov
3e57b1c180 doc: Added enum and typedef conventions 2020-06-01 14:41:43 +02:00
Marius Vikhammer
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
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
Krzysztof Budzynski
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
Krzysztof Budzynski
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
Krzysztof Budzynski
e58c0ac3e7 Provide a brief description of SmartConfig and add link to example 2020-05-18 01:02:04 +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
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
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
liying
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
Ivan Grokhotkov
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
Angus Gratton
52d888a68b docs: Fix broken URLs & permanent redirects 2020-03-23 18:11:23 +11:00
Angus Gratton
5fbf95d691 docs: Expand the description of per-target custom macro directives 2020-03-20 19:57:18 +11:00
Angus Gratton
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
Marius Vikhammer
9b56892bfe doc: fix broken .. only:: in JTAG guide
Added note about .. only:: limitations to guide
2020-03-03 15:30:37 +08:00