Skip to content

Commit

Permalink
doc(coq): document coqdoc_flags in env stanza
Browse files Browse the repository at this point in the history
Signed-off-by: Ali Caglayan <alizter@gmail.com>
  • Loading branch information
Alizter committed Nov 24, 2023
1 parent b545564 commit b3d2bf1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions doc/coq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -788,3 +788,19 @@ configuration. These are:

See :doc:`concepts/variables` for more information on variables supported by
Dune.


.. _coq-env:

Coq Environment Fields
----------------------

The :ref:`dune-env` stanza has a ``(coq <coq_fields>)`` field with the following
values for ``<coq_fields>``:

- ``(flags <flags>)``: The default flags passed to ``coqc``. The default value
is ``-q``. Values set here become the ``:standard`` value in the
``(coq.theory (flags <flags>))`` field.
- ``(coqdoc_flags <flags>)``: The default flags passed to ``coqdoc``. The default
value is ``--toc``. Values set here become the ``:standard`` value in the
``(coq.theory (coqdoc_flags <flags>))`` field.
2 changes: 1 addition & 1 deletion doc/stanzas/env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Fields supported in ``<settings>`` are:
- ``(odoc <fields>)`` allows passing options to ``odoc``. See
:ref:`odoc-options` for more details.

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

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

0 comments on commit b3d2bf1

Please sign in to comment.