Kirill Chalov
a55a0354e6
Merge branch 'docs/rewrite-api-ref-esp-timers' into 'master'
...
docs(rewrite): Rewrite esp_timer api ref and related docs
See merge request espressif/esp-idf!27034
2024-02-08 14:13:08 +08:00
kirill.chalov
8154150188
docs(esp_timer): Rewrite esp_timer api ref and related docs
2024-02-08 12:13:18 +08:00
Kirill Chalov
77770b2cb7
Merge branch 'docs/add_sphinx_lint' into 'master'
...
docs(sphinx-lint): Add sphinx-lint to pre-commit
See merge request espressif/esp-idf!28578
2024-01-23 17:48:22 +08:00
kirill.chalov
0181f8cc88
docs(sphinx-lint): Add sphinx-lint to pre-commit
...
Sphinx-lint helps in linting simple formatting issues with virtually
no false positives, such as trailing spaces, missing final newlines,
presence of tabs, absence of spaces and backticks around roles, etc.
2024-01-23 15:22:30 +08:00
kirill.chalov
22a053f1fc
docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit
2024-01-23 15:22:29 +08:00
Kirill Chalov
d6a5d55c02
Merge branch 'docs/add-vale-config' into 'master'
...
docs: add vale config
See merge request espressif/esp-idf!26227
2023-10-17 16:28:08 +08:00
kirill.chalov
746faca885
docs(vale): Add configuration for Vale documentation linter
...
This adds Espressif configuration (style) for Vale documentation linter.
If you add or update docs, consider running Vale with this configuration
on your contributions.
2023-10-10 15:27:09 +08:00
kirill.chalov
9a70313362
Added info on JTAG compatibility
2021-10-15 14:31:22 +08:00
kirill.chalov
f634c59289
Add hypertargets to all TRM references
2021-01-26 05:51:52 +00:00
kirill.chalov
954d55bad0
Docs: Add copybutton package to conf_common.py
2020-08-27 02:48:43 +00:00
kirill.chalov
1a81163802
Update description of power regulators for CAM v1.0 and v1.1
2020-08-17 11:32:14 +08:00
kirill.chalov
dee1ff0218
Add user guide for Kaluga Kit v1.3
2020-08-12 17:56:59 +08:00
Kirill Chalov
c65c1716cd
Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit
...
QR codes have already been issued for user-guide-kaluga-1-v1.2 and the links there are not working now. Add a redirect.
2020-05-18 17:28:03 +08:00
Kirill Chalov
2e5f983b5a
Add user guides for ESP32-S2-Kaluga-1-Kit
2020-05-13 07:12:42 +00:00
Kirill Chalov
0cc9ffb8f7
Implement comments and add info on ESP32S2
2020-04-08 10:30:22 +08:00
Kirill Chalov
9ed60af1f2
Review security/flash-encryption.rst
2020-04-08 10:30:22 +08:00
Kirill Chalov
1ead668d77
Issues with entering Download mode automatically
...
Add description to Getting started guides of possible issues preventing Development boards from entering Firmware Download mode automatically while trying to flash the boards
Closes https://jira.espressif.com:8443/browse/DOC-11
2020-03-04 04:58:29 +08:00
Kirill Chalov
b2d38cf324
Review the file api-reference/peripherals/esp_slave_protocol.rst
2020-03-03 18:12:56 +08:00
Kirill Chalov
c5f77cf6cb
Review the file api-reference/peripherals/i2c.rst
2020-01-09 17:04:41 +08:00
Kirill Chalov
ab6311c548
Reveiw the file api-reference/peripherals/i2s.rst
2019-12-29 21:05:57 +00:00
Kirill Chalov
9da268bd32
Review the file api-reference/peripherals/uart.rst
2019-12-19 19:13:38 +08:00
Kirill Chalov
db32140eea
JP8 -> JP2 syncing changes in cn version
...
Fixes https://github.com/espressif/esp-idf/pull/4147
2019-12-19 13:52:33 +08:00
Kirill Chalov
1d06b6b07e
Add information on compatibility issue between JTAG and AT firmware.
2019-11-20 15:01:56 +08:00
Kirill Chalov
22526c1701
Review the file api-reference/peripherals/sd_pullup_requirements.rst
2019-10-29 18:56:48 +08:00
Kirill Chalov
bdaf201bd0
Make "H/W Reference" toctree symmetrical
...
Update the toctree of "H/W Reference" to make its contents symmetrical for easier and more intuitive navigation.
2019-10-22 21:27:10 +08:00
Kirill Chalov
deda0091d9
Review the file api-reference/peripherals/spi_master.rst.
2019-10-21 16:13:16 +08:00
Kirill Chalov
2c7165f783
Review the file api-reference/peripherals/spi_slave.rst
2019-10-15 22:13:03 +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
Kirill Chalov
95552d4d13
Review the file api-reference/peripherals/sdspi_host.rst
2019-09-09 19:14:39 +08:00
Kirill Chalov
639687f92b
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
Kirill Chalov
75d7ca4b60
Review the file api-reference/peripherals/timer.rst
2019-07-19 15:06:52 +08:00
Kirill Chalov
d8b3676797
Review the file api-reference/peripherals/ledc.rst
2019-07-18 16:38:59 +08:00
Kirill Chalov
4db4402bed
Review the file api-reference/peripherals/sdmmc_host.rst
2019-06-24 21:46:11 +08:00
Kirill Chalov
32c3730c33
Review the file api-guides/external-ram.rst
2019-06-24 08:24:44 +08:00
Kirill Chalov
752c7c32d4
Review the file hw-reference/modules-and-boards.rst
2019-06-24 08:22:43 +08:00
Kirill Chalov
1096ee4b57
Review the file api-reference/peripherals/touch_pad.rst
2019-06-21 20:43:17 +08:00
Kirill Chalov
4faf2de035
Doc/review api ref storage
2019-06-17 14:23:52 +08:00
Kirill Chalov
588f059159
Doc/review power management
2019-05-29 12:59:52 +08:00
Kirill Chalov
b672002a5f
Doc/review api reference indexes
2019-04-29 10:53:42 +08:00
Kirill Chalov
b89ff9e6db
Review the versions.rst document.
2019-04-23 06:03:33 +00:00
Kirill Chalov
a01ec59f74
Review log.rst and index.rst files in api-reference/system
2019-04-11 15:33:38 +08:00
Kirill Chalov
ade05b4802
Delete a file which accidentally ended up in the idf's root derictory. Its original copy is safe and sound where it should be and is up to date.
2019-03-27 18:09:13 +08:00
Kirill Chalov
a1c39e4a53
Doc/review get st wrover kit
2019-03-26 16:12:42 +08:00
Kirill Chalov
bae824439e
Doc/review get st pico
2019-03-26 16:11:11 +08:00
Kirill Chalov
49cca9288f
Update IDF getting started sections for make and cmake as well as IDF monitor…
2019-03-14 00:10:26 +08:00