summaryrefslogtreecommitdiff
path: root/frags/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'frags/README.md')
-rw-r--r--frags/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/frags/README.md b/frags/README.md
index 0fe7923f..5070c7f1 100644
--- a/frags/README.md
+++ b/frags/README.md
@@ -10,3 +10,9 @@ If the fragment includes header lines, you MUST include it at top-level
Otherwise, it can be included at either top-level or indented.
See <https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment>.
+
+Tips:
+
+- Don't put index entries in frags/* files.
+ (They will result in a Sphinx warning.)
+ Instead, keep them in the *including* text.