Marius Vikhammer
0244c81fd2
docs: update getting started and frontpage docs for C6
2022-11-17 11:30:30 +08:00
Marius Vikhammer
030cb77597
docs: update redirected links
2022-05-07 13:09:41 +08:00
Marius Vikhammer
5f7733f692
docs: update frontpage/general pages for ESP8684
2021-12-21 11:14:35 +08:00
Marius Vikhammer
7411321603
docs: update to use esp-docs
2021-08-24 08:56:48 +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
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
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
Hao Ning
214c3a54b9
Doc/add chinese updates in contribute folder
2020-07-10 21:16:37 +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
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
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
Wang Ning
63b0d6c977
Add Chinese translation to Documenting Code
2019-12-13 20:13:50 +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
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
d0b8f2865f
docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com
2018-06-19 11:23:33 +00: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
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
