diff options
author | Thien-Thi Nguyen <ttn@gnuvola.org> | 2020-12-14 02:02:20 -0500 |
---|---|---|
committer | Thien-Thi Nguyen <ttn@gnuvola.org> | 2020-12-14 02:02:20 -0500 |
commit | 22fce4576d972bbd091448092e19ea7bf259ae8e (patch) | |
tree | b44c8d52abd048475cdc6ab69f550376ae8f56a1 /frags | |
parent | aa9233f81df5cd45ee0d69310e2d587517a2a46e (diff) | |
download | docs-22fce4576d972bbd091448092e19ea7bf259ae8e.tar.gz docs-22fce4576d972bbd091448092e19ea7bf259ae8e.tar.bz2 docs-22fce4576d972bbd091448092e19ea7bf259ae8e.zip |
add Tips section to frags/README.md
Diffstat (limited to 'frags')
-rw-r--r-- | frags/README.md | 6 |
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. |