diff options
| author | Thomas Letan | 2019-07-27 13:26:17 +0200 |
|---|---|---|
| committer | Théo Zimmermann | 2020-03-28 16:53:38 +0100 |
| commit | 86d5ed1d96a93c074a070c86b1c3c81088e4cd2d (patch) | |
| tree | 6082d5fca9b134ea4f0753dd2b1dda578224f39b /doc/sphinx/using | |
| parent | 28081c1108a84050566d365bd665d05ee508ecce (diff) | |
coqdoc: Add (* begin details *) and (* end details *)
We propose to add an environment to have foldable texts with HTML
output, more precisely:
(*begin details [: An optional summary] *)
some Coq and documentation material
(* end details *)
Currently, only the HTML output is supported. We could treat this
environment in LaTeX output as appendixes to output later.
Diffstat (limited to 'doc/sphinx/using')
| -rw-r--r-- | doc/sphinx/using/tools/coqdoc.rst | 21 |
1 files changed, 21 insertions, 0 deletions
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 ~~~~~ |
