diff options
Diffstat (limited to 'doc/sphinx/frags/README.md')
-rw-r--r-- | doc/sphinx/frags/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/sphinx/frags/README.md b/doc/sphinx/frags/README.md new file mode 100644 index 0000000..5070c7f --- /dev/null +++ b/doc/sphinx/frags/README.md @@ -0,0 +1,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. |