From ddb3fae72826c0da3ba449be4ebc72e44c1ace16 Mon Sep 17 00:00:00 2001
From: Emilio Jesus Gallego Arias
Date: Wed, 19 Sep 2018 02:50:29 +0200
Subject: [dune] [doc] Support for building the reference manual with Dune.

This is a reduced version of #8503 as to provide a way to build the
reference manual with Dune.

Dune 1.6 supports (experimentally) directories as targets, thus we
introduce a rule that will call `sphinx` to build the manual.

This only provides build, however generation of `.install` rules is
not done, it will be hopefully addressed in #8503.

Note that we set `expire: 1 month` for all the artifacts we build with
Dune. IMHO this makes most sense as not to abuse Gitlab's hosting,
however of course we could consider a different deployment strategy if
wanted.
---
 dev/doc/build-system.dune.md | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

(limited to 'dev/doc')

diff --git a/dev/doc/build-system.dune.md b/dev/doc/build-system.dune.md
index 3609171b82..01c32041d2 100644
--- a/dev/doc/build-system.dune.md
+++ b/dev/doc/build-system.dune.md
@@ -10,9 +10,9 @@ Coq can now be built using [Dune](https://github.com/ocaml/dune).
 
 ## Quick Start
 
-Dune >= 1.5.0 is recommended, see `dune-project` for the minimum
-required version; type `dune build` to build the base Coq
-libraries. No call to `./configure` is needed.
+Usually, using the latest version of Dune is recommended, see
+`dune-project` for the minimum required version; type `dune build` to
+build the base Coq libraries. No call to `./configure` is needed.
 
 Dune will get confused if it finds leftovers of in-tree compilation,
 so please be sure your tree is clean from objects files generated by
@@ -63,11 +63,16 @@ ml files in quick mode.
 Dune also provides targets for documentation, testing, and release
 builds, please see below.
 
-## Documentation and test targets
+## Documentation and testing targets
 
 Coq's test-suite can be run with `dune runtest`.
 
-The documentation target is not implemented in Dune yet.
+There is preliminary support to build the API documentation and
+reference manual in HTML format, use `dune build {@doc,@refman-html}`
+to generate them.
+
+So far these targets will build the documentation artifacts, however
+no install rules are generated yet.
 
 ## Developer shell
 
-- 
cgit v1.2.3