Skip to content

Commit b3d2bf1

Browse files
committed
doc(coq): document coqdoc_flags in env stanza
Signed-off-by: Ali Caglayan <alizter@gmail.com>
1 parent b545564 commit b3d2bf1

2 files changed

Lines changed: 17 additions & 1 deletion

File tree

doc/coq.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -788,3 +788,19 @@ configuration. These are:
788788

789789
See :doc:`concepts/variables` for more information on variables supported by
790790
Dune.
791+
792+
793+
.. _coq-env:
794+
795+
Coq Environment Fields
796+
----------------------
797+
798+
The :ref:`dune-env` stanza has a ``(coq <coq_fields>)`` field with the following
799+
values for ``<coq_fields>``:
800+
801+
- ``(flags <flags>)``: The default flags passed to ``coqc``. The default value
802+
is ``-q``. Values set here become the ``:standard`` value in the
803+
``(coq.theory (flags <flags>))`` field.
804+
- ``(coqdoc_flags <flags>)``: The default flags passed to ``coqdoc``. The default
805+
value is ``--toc``. Values set here become the ``:standard`` value in the
806+
``(coq.theory (coqdoc_flags <flags>))`` field.

doc/stanzas/env.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Fields supported in ``<settings>`` are:
6262
- ``(odoc <fields>)`` allows passing options to ``odoc``. See
6363
:ref:`odoc-options` for more details.
6464

65-
- ``(coq (flags <flags>))`` allows passing options to Coq. See :ref:`coq-theory`
65+
- ``(coq <coq_fields>)`` allow passing options to Coq. See :ref:`coq-env`
6666
for more details.
6767

6868
- ``(formatting <settings>)`` allows the user to set auto-formatting in the

0 commit comments

Comments
 (0)