aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx/README.rst
diff options
context:
space:
mode:
authorJim Fehrle2019-12-21 22:15:21 -0800
committerJim Fehrle2020-02-28 10:39:15 -0800
commitff0ff3e5aa1b03aff4ae4ed6d4d357161ccd4b54 (patch)
tree73aebdcbc0d93d34d2ca32950c9e208d8b4d6d27 /doc/sphinx/README.rst
parent3c23ebeb1f5c4d32edeb7517a0e8168e0369f75b (diff)
Convert Gallina Vernac to use prodn
Diffstat (limited to 'doc/sphinx/README.rst')
-rw-r--r--doc/sphinx/README.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/sphinx/README.rst b/doc/sphinx/README.rst
index a34b2d5195..89b4bda71a 100644
--- a/doc/sphinx/README.rst
+++ b/doc/sphinx/README.rst
@@ -34,14 +34,14 @@ Names (link targets) are auto-generated for most simple objects, though they can
Most objects should have a body (i.e. a block of indented text following the signature, called “contents” in Sphinx terms). Undocumented objects should have the ``:undocumented:`` flag instead, as shown above. When multiple objects have a single description, they can be grouped into a single object, like this (semicolons can be used to separate the names of the objects; names starting with ``_`` will be omitted from the indexes)::
- .. cmdv:: Lemma @ident {? @binders} : @type
- Remark @ident {? @binders} : @type
- Fact @ident {? @binders} : @type
- Corollary @ident {? @binders} : @type
- Proposition @ident {? @binders} : @type
+ .. cmdv:: Lemma @ident {* @binder } : @type
+ Remark @ident {* @binder } : @type
+ Fact @ident {* @binder } : @type
+ Corollary @ident {* @binder } : @type
+ Proposition @ident {* @binder } : @type
:name: Lemma; Remark; Fact; Corollary; Proposition
- These commands are all synonyms of :n:`Theorem @ident {? @binders } : type`.
+ These commands are all synonyms of :n:`Theorem @ident {* @binder } : type`.
Notations
---------
@@ -89,10 +89,15 @@ Objects
Here is the list of all objects of the Coq domain (The symbol :black_nib: indicates an object whose signature can be written using the notations DSL):
+``.. attr::`` :black_nib: An attribute.
+ Example::
+
+ .. attr:: local
+
``.. cmd::`` :black_nib: A Coq command.
Example::
- .. cmd:: Infix "@symbol" := @term ({+, @modifier}).
+ .. cmd:: Infix @string := @term1_extended {? ( {+, @syntax_modifier } ) } {? : @ident }
This command is equivalent to :n:`…`.