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.
pull/5307/head
Marius Vikhammer 2020-05-12 11:32:34 +08:00
rodzic 1ad1791df7
commit 6d56ac8b84
1 zmienionych plików z 2 dodań i 2 usunięć

Wyświetl plik

@ -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"}