From 6d56ac8b84b03cb1b950fa7ae410d5d8194cb8e2 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Tue, 12 May 2020 11:32:34 +0800 Subject: [PATCH] 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. --- docs/en/contribute/documenting-code.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/contribute/documenting-code.rst b/docs/en/contribute/documenting-code.rst index dee7a199a..838756740 100644 --- a/docs/en/contribute/documenting-code.rst +++ b/docs/en/contribute/documenting-code.rst @@ -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"}