[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] 01/02: add Tips section to frags/README.md
From: |
gnunet |
Subject: |
[taler-docs] 01/02: add Tips section to frags/README.md |
Date: |
Mon, 14 Dec 2020 10:05:05 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a commit to branch master
in repository docs.
commit 22fce4576d972bbd091448092e19ea7bf259ae8e
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
AuthorDate: Mon Dec 14 02:02:20 2020 -0500
add Tips section to frags/README.md
---
frags/README.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/frags/README.md b/frags/README.md
index 0fe7923..5070c7f 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.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.