summaryrefslogtreecommitdiff
path: root/hadrian
diff options
context:
space:
mode:
authorMatthew Pickering <matthewtpickering@gmail.com>2021-07-20 09:22:06 +0100
committerMatthew Pickering <matthewtpickering@gmail.com>2021-07-20 09:22:46 +0100
commitd706fd0432925caf62673a55237a005e22bc4450 (patch)
treef5cc495c66d12baf94b1a253696c667d2b8b0ded /hadrian
parent58b960d2af0ebfc37104ec68a4df377a074951dd (diff)
downloadhaskell-d706fd0432925caf62673a55237a005e22bc4450.tar.gz
hadrian: Update docs targets documentation [skip ci]wip/hadrian-docs-targets
The README had got a little out of sync with the current state of affairs.
Diffstat (limited to 'hadrian')
-rw-r--r--hadrian/README.md24
1 files changed, 21 insertions, 3 deletions
diff --git a/hadrian/README.md b/hadrian/README.md
index d2ade59dd0..55e16268bf 100644
--- a/hadrian/README.md
+++ b/hadrian/README.md
@@ -243,9 +243,27 @@ These stages can be summarized graphically:
#### Documentation
-To build GHC documentation, run `build docs`. Note that finer-grain
-documentation targets (e.g. building only HTML documentation or only the GHC
-User's Guide) are currently not supported.
+To build all GHC documentation, run `build docs`. This includes
+
+* Haddock documentation for all libraries
+* The user guide (PDF and HTML)
+* The man page
+
+In order to only build haddock document there is the `build docs-haddock` target.
+
+Alternatively,
+you can use the `--docs` CLI flag to selectively disable some or
+all of the documentation targets:
+
+- `--docs=none`: don't build any docs
+- `--docs=no-haddocks`: don't build haddocks
+- `--docs=no-sphinx`: don't build any user manual or manpage
+- `--docs=no-sphinx-html`: don't build HTML versions of manuals
+- `--docs=no-sphinx-pdfs`: don't build PDF versions of manuals
+- `--docs=no-sphinx-man`: don't build the manpage
+
+You can pass several `--docs=...` flags, Hadrian will combine
+their effects.
#### Source distribution