starlingx/docs
Code Issues Proposed changes

Add note to new files (r9, r8, r7, r6, r5)

Browse Source 
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 <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2024-06-19 10:59:51 +00:00
parent 684643bf49
commit d466920c10
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
templates/topic-templates.txt
View File

@ -3,7 +3,10 @@ echo "Loading topic types ..."
# Add convenience templates for rst content here. # Add convenience templates for rst content here.
# Task-oriented procedures # Task-oriented procedures
task=".. _$filename: task=".. WARNING: Add no lines of text between the label immediately following
.. and the title.
.. _$filename:
$strike $strike
$title $title
@ -31,7 +34,10 @@ $strike
# Index file names should be unique across all repos # 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 $strike
$title $title
@ -48,7 +54,10 @@ $strike
" "
# Tabular data # Tabular data
reference=".. _$filename: reference=".. WARNING: Add no lines of text between the label immediately following
.. and the title.
.. _$filename:
$strike $strike
$title $title
@ -67,7 +76,10 @@ $strike
" "
# Generic topic # Generic topic
topic=".. _$filename: topic=".. WARNING: Add no lines of text between the label immediately following
.. and the title.
.. _$filename:
$strike $strike
$title $title