diff options
| author | Jim Fehrle | 2020-04-30 16:51:08 -0700 |
|---|---|---|
| committer | Jim Fehrle | 2020-05-18 19:39:34 -0700 |
| commit | ae208f062d15773781cb600e9a7b2c44de25caf9 (patch) | |
| tree | 18e161f903d580efd16766aff39ad020812fbf99 /doc/sphinx | |
| parent | 7cac115647723f8261b7aabf8094572227b25c43 (diff) | |
Support :gdef:`text <term>` syntax (adding "<term>")
Diffstat (limited to 'doc/sphinx')
| -rw-r--r-- | doc/sphinx/README.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/sphinx/README.rst b/doc/sphinx/README.rst index e20469bb8b..f91874d74d 100644 --- a/doc/sphinx/README.rst +++ b/doc/sphinx/README.rst @@ -359,11 +359,14 @@ In addition to the objects and directives above, the ``coqrst`` Sphinx plugin de and reference its tokens using ``:token:`…```. ``:gdef:`` Marks the definition of a glossary term inline in the text. Matching :term:`XXX` - constructs will link to it. The term will also appear in the Glossary Index. + constructs will link to it. Use the form :gdef:`text <term>` to display "text" + for the definition of "term", such as when "term" must be capitalized or plural + for grammatical reasons. The term will also appear in the Glossary Index. - Example:: + Examples:: A :gdef:`prime` number is divisible only by itself and 1. + :gdef:`Composite <composite>` numbers are the non-prime numbers. Common mistakes =============== |