From d466920c10413dedfb802e60e32ab819ce3efb19 Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Wed, 19 Jun 2024 10:59:51 +0000 Subject: [PATCH] Add note to new files (r9, r8, r7, r6, r5) Add a warning to top of new rst files created using tox -e newfile. The warning states that content should not be inserted between the label and the title. This breaks auto-resolution of link anchors. Change-Id: I654300d0232dbcb42c0f939f5fbe3d4935f4549c Signed-off-by: Ron Stone --- templates/topic-templates.txt | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/templates/topic-templates.txt b/templates/topic-templates.txt index 57f8ab949..2b6611655 100644 --- a/templates/topic-templates.txt +++ b/templates/topic-templates.txt @@ -3,7 +3,10 @@ echo "Loading topic types ..." # Add convenience templates for rst content here. # Task-oriented procedures -task=".. _$filename: +task=".. WARNING: Add no lines of text between the label immediately following +.. and the title. + +.. _$filename: $strike $title @@ -31,7 +34,10 @@ $strike # Index file names should be unique across all repos -index=".. _$filename: +index=".. WARNING: Add no lines of text between the label immediately following +.. and the title. + +.. _$filename: $strike $title @@ -48,7 +54,10 @@ $strike " # Tabular data -reference=".. _$filename: +reference=".. WARNING: Add no lines of text between the label immediately following +.. and the title. + +.. _$filename: $strike $title @@ -67,7 +76,10 @@ $strike " # Generic topic -topic=".. _$filename: +topic=".. WARNING: Add no lines of text between the label immediately following +.. and the title. + +.. _$filename: $strike $title