aboutsummaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
authorEmilio Jesus Gallego Arias2018-12-27 11:14:59 +0100
committerEmilio Jesus Gallego Arias2018-12-27 11:14:59 +0100
commit2760bdc584d3b49d9ebcd2052c6be13e08cb1429 (patch)
tree8bdb4aa1b6e1d32be3a2b70998c147212a85a2fb /doc/README.md
parent721457e41db164057025f48a8a46596397c0c5c8 (diff)
parent3d833269860ae9fe8e6f4a3d936d23404afe453e (diff)
Merge PR #9277: [dune] Build refman with fatal warnings like in the Makefile build.
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md27
1 files changed, 15 insertions, 12 deletions
diff --git a/doc/README.md b/doc/README.md
index 3db1261656..c41d269437 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -101,18 +101,21 @@ Alternatively, you can use some specific targets:
Also note the `-with-doc yes` option of `./configure` to enable the
build of the documentation as part of the default make target.
-If you're editing Sphinx documentation, set SPHINXWARNERROR to 0
-to avoid treating Sphinx warnings as errors. Otherwise, Sphinx quits
-upon detecting the first warning. You can set this on the Sphinx `make`
-command line or as an environment variable:
-
-- `make refman SPHINXWARNERROR=0`
-
-- ~~~
- export SPHINXWARNERROR=0
- ⋮
- make refman
- ~~~
+To build the Sphinx documentation without stopping at the first
+warning with the legacy Makefile, set `SPHINXWARNERROR` to 0 as such:
+
+```
+SPHINXWARNERROR=0 make refman-html
+```
+
+To do the same with the Dune build system, change the value of the
+`SPHINXWARNOPT` variable (default is `-W`). The following will build
+the Sphinx documentation without stopping at the first warning, and
+store all the warnings in the file `/tmp/warn.log`:
+
+```
+SPHINXWARNOPT="-w/tmp/warn.log" dune build @refman-html
+```
Installation
------------