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

Merge branch 'doc/documenting_code_format_fix' into 'master'

Browse Source 
docs: change descriptions of substitution defines to use literal blocks

See merge request espressif/esp-idf!8699
This commit is contained in:
Krzysztof Budzynski 2020-05-14 15:03:41 +08:00
commit ad9e514ff4
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/contribute/documenting-code.rst
View File

@ -328,11 +328,11 @@ Would render in the documentation as:
This is a {IDF_TARGET_NAME}, with /{IDF_TARGET_PATH_NAME}/soc.c, compiled with `xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf-gcc` with `CONFIG_{IDF_TARGET_CFG_PREFIX}_MULTI_DOC`.
This extension also supports markup for defining local (within a single source file) substitutions. Place a definition like the following into a single line of the RST file:
This extension also supports markup for defining local (within a single source file) substitutions. Place a definition like the following into a single line of the RST file::
{\IDF_TARGET_SUFFIX:default="DEFAULT_VALUE", esp32="ESP32_VALUE", esp32s2="ESP32S2_VALUE"}
This will define a target-dependent substitution of the tag {\IDF_TARGET_SUFFIX} in the current RST file. For example:
This will define a target-dependent substitution of the tag {\IDF_TARGET_SUFFIX} in the current RST file. For example::
{\IDF_TARGET_TX_PIN:default="IO3", esp32="IO4", esp32s2="IO5"}