diff options
| author | Jim Fehrle | 2018-09-01 12:36:38 -0700 |
|---|---|---|
| committer | Jim Fehrle | 2018-09-20 14:27:02 -0700 |
| commit | d4b5de427d94d82f09d58e0f1095f052a5900914 (patch) | |
| tree | 3b153e2786a2745f49dee24adeda0887d515bb12 /doc/sphinx | |
| parent | 4f85e540349004d4f9388a90061fc4a1541d9c40 (diff) | |
Define flags (binary-valued settings) and tables (settings that are sets)
as separate NotationObject types, include in index.
Diffstat (limited to 'doc/sphinx')
| -rw-r--r-- | doc/sphinx/README.rst | 22 | ||||
| -rw-r--r-- | doc/sphinx/coq-exnindex.rst | 6 | ||||
| -rw-r--r-- | doc/sphinx/coq-optindex.rst | 6 |
3 files changed, 26 insertions, 8 deletions
diff --git a/doc/sphinx/README.rst b/doc/sphinx/README.rst index 369a3a0db8..c1f3f7b4d0 100644 --- a/doc/sphinx/README.rst +++ b/doc/sphinx/README.rst @@ -114,15 +114,33 @@ Here is the list of all objects of the Coq domain (The symbol :black_nib: indica Raised if :n:`@tactic` does not fully solve the goal. -``.. opt::`` :black_nib: A Coq option. +``.. flag::`` :black_nib: A Coq flag (i.e a binary-valued setting). Example:: - .. opt:: Nonrecursive Elimination Schemes + .. flag:: Nonrecursive Elimination Schemes This option controls whether types declared with the keywords :cmd:`Variant` and :cmd:`Record` get an automatic declaration of the induction principles. +``.. opt::`` :black_nib: A Coq option (with a string or numeric value; use "flag" for binary options) + Example:: + + .. opt:: Printing Width @num + :name: Printing Width + + This command sets which left-aligned part of the width of the screen is used + for display. At the time of writing this documentation, the default value + is 78. + +``.. table::`` :black_nib: A Coq table (i.e a setting whose value is a set). + Example:: + + .. table:: Search Blacklist @string + :name: Search Blacklist + + This table controls ... + ``.. prodn::`` A grammar production. This is useful if you intend to document individual grammar productions. Otherwise, use Sphinx's `production lists diff --git a/doc/sphinx/coq-exnindex.rst b/doc/sphinx/coq-exnindex.rst index dbf60bb06c..fc55e91eee 100644 --- a/doc/sphinx/coq-exnindex.rst +++ b/doc/sphinx/coq-exnindex.rst @@ -2,6 +2,6 @@ .. hack to get index in TOC ----------------------- -Errors, warnings index ----------------------- +------------------------- +Errors and warnings index +------------------------- diff --git a/doc/sphinx/coq-optindex.rst b/doc/sphinx/coq-optindex.rst index 925d4cd185..0961bea61f 100644 --- a/doc/sphinx/coq-optindex.rst +++ b/doc/sphinx/coq-optindex.rst @@ -2,6 +2,6 @@ .. hack to get index in TOC ------------------ -Option index ------------------ +------------------------------- +Flags, options and tables index +------------------------------- |