Browse Source

Document building EDoc on all apps in multi-apps projects

Loïc Hoguin 6 years ago
parent
commit
2110fb337b
1 changed files with 13 additions and 0 deletions
  1. 13 0
      doc/src/guide/edoc.asciidoc

+ 13 - 0
doc/src/guide/edoc.asciidoc

@@ -46,3 +46,16 @@ the following to your Makefile:
 ----
 ----
 docs:: edoc
 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)
+----