alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
34,535 Commits 20 Branches 148 Tags 384 MiB
13dd2c9aae
Commit Graph

117 Commits

Author SHA1 Message Date
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
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
Marius Vikhammer
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
Angus Gratton
291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +11:00
Angus Gratton
4636e8a34c docs/documenting-code: Add a couple of follow up notes on top of last commit 2020-02-07 16:37:45 +11:00
Marius Vikhammer
9f617c7874 docs: Add a short user guide for how to write multi target docs 2020-02-07 16:37:45 +11:00
Angus Gratton
50324b505d docs: Note that the idf target formatting filters don't work on "included" documents 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
Marius Vikhammer
105567d077 doc: updated peripherals api-reference for s2 2020-02-07 16:37:44 +11:00
Marius Vikhammer
d56ea52ea1 doc: EN doc update and fixed warnings 2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69 doc: Update English pages with generic target name 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
Jakob Hasse
9a10c1bccd doc: small changes for cxx code style 2020-01-07 15:13:41 +08:00
Wang Ning
63b0d6c977 Add Chinese translation to Documenting Code 2019-12-13 20:13:50 +08:00
Jakob Hasse
e33153f633 Added basic C++ style guide 
* C++ style guide
* Changed headings to "Title Case"
 2019-10-09 12:25:48 +08:00
Kirill Chalov
f0dc5f8dc2 Apply suggestion to docs/en/contribute/documenting-code.rst 2019-09-12 12:36:13 +08: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
Krzysztof Budzynski
cb87e786a5 docs: Introduced custom 404 page in readthedocs documentation to replace… 2019-03-28 01:38:31 +08:00
krzychb
ed0db52f74 docs: This is a quick reference of more than a dozen and-ons and extensions prepared over the last two years to add contents, improve look & feel and cut on maintenance of the ESP-IDF documentation. 2019-02-17 20:32:50 +01:00
krzychb
f675334ebb Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 19:01:34 +01:00
liying
df9d1cc5d4 doc:update_creating_example_cn 2018-11-07 17:18:51 +08:00
Roland Dobai
c3d99dd2e4 Encourage to install python packages without administrative rights 
Using 'sudo pip install' can cause a lot of problems because usually
there are a couple of Python interpreters installed. This fix encourages
developers to use `pip install --user` instead which is safer.
 2018-09-11 08:54:37 +02:00
Angus Gratton
ff2404a272 Merge branch 'master' into feature/cmake 2018-08-16 17:14:17 +10:00
Angus Gratton
74245d27d3 ci: Add line endings check for CRLF in repository 2018-07-12 19:10:37 +08:00
krzychb
8a7ee46b7f Fixed link to 'TEMPLATE_EXAMPLE_README.md' 2018-07-01 19:33:37 +02:00
Angus Gratton
75d732887b Merge branch 'doc/examples_guide' into 'master' 
docs: Add "Creating Examples" docs page, template example README

See merge request idf/esp-idf!2536
 2018-06-21 13:59:44 +08:00
Angus Gratton
d0b8f2865f docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com 2018-06-19 11:23:33 +00:00
Angus Gratton
df4e227855 docs: Add "Creating Examples" docs page, template example README 2018-06-14 16:49:22 +10:00
Angus Gratton
6b9784cc45 Merge branch 'master' into feature/cmake_update 2018-05-31 14:46:23 +10:00
krzychb
d754b53ae2 Implemented docutils custom role that renders a link to current documentation page on Read The Docs in another language version 
Provided documentation of the role.
 2018-05-21 10:30:07 +08:00
Angus Gratton
88df8fd293 cmake: Use cmake_lint project, tidy up all CMake source files 2018-04-30 09:59:20 +10:00
Angus Gratton
9f8cdd3572 cmake: Add "Preview release" getting start guide & build system documentation 2018-04-30 09:59:20 +10:00
krzychb
40bc387bae Restored back original 'zh_CN' version files and updated links between versions 2018-03-13 21:57:08 +01:00
krzychb
097adc3a33 Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00