diff options
| author | Théo Zimmermann | 2020-09-11 12:39:39 +0200 |
|---|---|---|
| committer | Théo Zimmermann | 2020-09-11 12:39:39 +0200 |
| commit | 795af932ef6606ba8385448244f60c728e9abdbd (patch) | |
| tree | ccbe1956742176260fcb9b5ff5814570bf216bfa /doc/sphinx | |
| parent | 6abc0f4de27e4c0ecbbc7736388682abe21ebd7f (diff) | |
Remove outdated references to productionlist.
Diffstat (limited to 'doc/sphinx')
| -rw-r--r-- | doc/sphinx/README.rst | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/sphinx/README.rst b/doc/sphinx/README.rst index f91874d74d..d799ecfe83 100644 --- a/doc/sphinx/README.rst +++ b/doc/sphinx/README.rst @@ -346,17 +346,15 @@ In addition to the objects and directives above, the ``coqrst`` Sphinx plugin de creates a link to that. When referring to a placeholder that happens to be a grammar production, ``:token:`…``` is typically preferable to ``:n:`@…```. -``:production:`` A grammar production not included in a ``productionlist`` directive. +``:production:`` A grammar production not included in a ``prodn`` directive. Useful to informally introduce a production, as part of running text. Example:: :production:`string` indicates a quoted string. - You're not likely to use this role very commonly; instead, use a - `production list - <http://www.sphinx-doc.org/en/stable/markup/para.html#directive-productionlist>`_ - and reference its tokens using ``:token:`…```. + You're not likely to use this role very commonly; instead, use a ``prodn`` + directive 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. Use the form :gdef:`text <term>` to display "text" |
