Browse Source

Merge branch 'master' of git://github.com/kaos/erlang.mk

Loïc Hoguin 11 years ago
parent
commit
25041ba7eb
2 changed files with 9 additions and 1 deletions
  1. 6 0
      README.md
  2. 3 1
      erlang.mk

+ 6 - 0
README.md

@@ -174,6 +174,12 @@ downloaded to. It defaults to `deps`. It will be propagated into
 all the subsequent make calls, allowing all dependencies to use
 all the subsequent make calls, allowing all dependencies to use
 the same folder as expected.
 the same folder as expected.
 
 
+`EDOC_OPTS` allows you to specify
+[options](http://www.erlang.org/doc/man/edoc.html#run-3) to pass to
+`edoc` when building the documentation. Notice: not all options are
+documented in one place; follow the links to get to the options for
+the various operations of the documentation generation.
+
 `CT_SUITES` is the list of common_test suites to run when you use
 `CT_SUITES` is the list of common_test suites to run when you use
 the `make tests` command. If your suite module is named `ponies_SUITE`
 the `make tests` command. If your suite module is named `ponies_SUITE`
 then you only need to put `ponies` in the list.
 then you only need to put `ponies` in the list.

+ 3 - 1
erlang.mk

@@ -189,9 +189,11 @@ clean-deps:
 
 
 # Documentation.
 # Documentation.
 
 
+EDOC_OPTS ?=
+
 docs: clean-docs
 docs: clean-docs
 	$(gen_verbose) erl -noshell \
 	$(gen_verbose) erl -noshell \
-		-eval 'edoc:application($(PROJECT), ".", []), init:stop().'
+		-eval 'edoc:application($(PROJECT), ".", [$(EDOC_OPTS)]), init:stop().'
 
 
 clean-docs:
 clean-docs:
 	$(gen_verbose) rm -f doc/*.css doc/*.html doc/*.png doc/edoc-info
 	$(gen_verbose) rm -f doc/*.css doc/*.html doc/*.png doc/edoc-info