diff options
| author | Thien-Thi Nguyen <ttn@gnuvola.org> | 2020-12-11 15:22:18 -0500 |
|---|---|---|
| committer | Thien-Thi Nguyen <ttn@gnuvola.org> | 2020-12-11 15:22:18 -0500 |
| commit | cc32ee651a54aaf86f95208b37e789be947c4ef3 (patch) | |
| tree | c0175334b68602631c49bac59190d851bde3c650 /frags | |
| parent | 17eb8974167cea2307dedd6c41b79aa78f6ce6ac (diff) | |
| download | docs-cc32ee651a54aaf86f95208b37e789be947c4ef3.tar.gz docs-cc32ee651a54aaf86f95208b37e789be947c4ef3.tar.bz2 docs-cc32ee651a54aaf86f95208b37e789be947c4ef3.zip | |
clarify ‘.. include::’ placement in README.md
Diffstat (limited to 'frags')
| -rw-r--r-- | frags/README.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/frags/README.md b/frags/README.md index 9facc4c0..0fe7923f 100644 --- 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>. |