aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-11-24 18:13:23 +0100
committerLoïc Hoguin <[email protected]>2018-11-24 18:13:23 +0100
commit2110fb337b4457012d7a97fcc5071b095b7be861 (patch)
treeecccc1a43f98c03cd998c902fa46fa97e84cac02 /doc/src/guide
parentde49be49a31dde4b504bd02fc149186ee6662f20 (diff)
downloaderlang.mk-2110fb337b4457012d7a97fcc5071b095b7be861.tar.gz
erlang.mk-2110fb337b4457012d7a97fcc5071b095b7be861.tar.bz2
erlang.mk-2110fb337b4457012d7a97fcc5071b095b7be861.zip
Document building EDoc on all apps in multi-apps projects
Diffstat (limited to 'doc/src/guide')
-rw-r--r--doc/src/guide/edoc.asciidoc13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/src/guide/edoc.asciidoc b/doc/src/guide/edoc.asciidoc
index 9fc1a74..2992a37 100644
--- a/doc/src/guide/edoc.asciidoc
+++ b/doc/src/guide/edoc.asciidoc
@@ -46,3 +46,16 @@ the following to your Makefile:
----
docs:: edoc
----
+
+=== Running EDoc on all applications
+
+In a multi-application project you may want to run EDoc
+against all applications at the same time, instead of
+against each applications independently. To do so, you
+need to configure the `EDOC_SRC_DIRS` at the end of
+your Makefile, after including 'erlang.mk':
+
+[source,make]
+----
+EDOC_SRC_DIRS = $(ALL_APPS_DIRS)
+----