commit cc32ee651a54aaf86f95208b37e789be947c4ef3 parent 17eb8974167cea2307dedd6c41b79aa78f6ce6ac Author: Thien-Thi Nguyen <ttn@gnuvola.org> Date: Fri, 11 Dec 2020 15:22:18 -0500 clarify ‘.. include::’ placement in README.md Diffstat:
| M | frags/README.md | | | 6 | ++++-- |
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/frags/README.md b/frags/README.md @@ -4,7 +4,9 @@ This directory contains fragments to be included by the directive: .. include:: RELATIVE-FILE-NAME -If the fragment includes headers, you MUST include it at top-level. -Otherwise, you MUST include it only at "block" level. +If the fragment includes header lines, you MUST include it at top-level +(no indentation for the directive). + +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>.