diff options
| author | Lysxia | 2020-04-01 10:56:15 -0400 |
|---|---|---|
| committer | Lysxia | 2020-04-01 10:56:15 -0400 |
| commit | b4524a7e8deb0144cb00ee2db823c98392fb208e (patch) | |
| tree | d707a106aee5afa79e6cc277faced4a86faeda1d /doc | |
| parent | 828b79f744ffc1f292a77a80553906544c1c0cfb (diff) | |
| parent | 86d5ed1d96a93c074a070c86b1c3c81088e4cd2d (diff) | |
Merge PR #10592: coqdoc: Add a new `details' environment for coqdoc
Reviewed-by: Lysxia
Reviewed-by: Zimmi48
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/changelog/08-tools/10592-coqdoc-details.rst | 5 | ||||
| -rw-r--r-- | doc/sphinx/using/tools/coqdoc.rst | 21 |
2 files changed, 26 insertions, 0 deletions
diff --git a/doc/changelog/08-tools/10592-coqdoc-details.rst b/doc/changelog/08-tools/10592-coqdoc-details.rst new file mode 100644 index 0000000000..c5bdc1dbb0 --- /dev/null +++ b/doc/changelog/08-tools/10592-coqdoc-details.rst @@ -0,0 +1,5 @@ +- **Added:** + A new documentation environment ``details`` to make certain portion + of a Coq document foldable. See :ref:`coqdoc` + (`#10592 <https://github.com/coq/coq/pull/10592>`_, + by Thomas Letan). diff --git a/doc/sphinx/using/tools/coqdoc.rst b/doc/sphinx/using/tools/coqdoc.rst index cada680895..b4b14fb392 100644 --- a/doc/sphinx/using/tools/coqdoc.rst +++ b/doc/sphinx/using/tools/coqdoc.rst @@ -248,6 +248,27 @@ shown using such comments: The latter cannot be used around some inner parts of a proof, but can be used around a whole proof. +Lastly, it is possible to adopt a middle-ground approach when the +desired output is HTML, where a given snippet of Coq material is +hidden by default, but can be made visible with user interaction. + +:: + + + (* begin details *) + *some Coq material* + (* end details *) + + +There is also an alternative syntax available. + +:: + + + (* begin details : Some summary describing the snippet *) + *some Coq material* + (* end details *) + Usage ~~~~~ |