summaryrefslogtreecommitdiff
path: root/frags/README.md
blob: 5070c7f196bcbd07cfa2e35a9eea8f2d9c8e4ac1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# docs.git/frags

This directory contains fragments to be included by the directive:

  .. include:: RELATIVE-FILE-NAME

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>.

Tips:

- Don't put index entries in frags/* files.
  (They will result in a Sphinx warning.)
  Instead, keep them in the *including* text.