diff options
author | Andreas Stenius <[email protected]> | 2013-10-09 11:10:01 +0200 |
---|---|---|
committer | Andreas Stenius <[email protected]> | 2013-11-06 14:49:28 +0100 |
commit | acfa33561cc06e7a085420fc3381188bcd0903d2 (patch) | |
tree | abb4bd68b95aaa34dc358e37ee6056d47512090f | |
parent | 4a1942695b8aa000e22ac5533474725dc7690ec6 (diff) | |
download | erlang.mk-acfa33561cc06e7a085420fc3381188bcd0903d2.tar.gz erlang.mk-acfa33561cc06e7a085420fc3381188bcd0903d2.tar.bz2 erlang.mk-acfa33561cc06e7a085420fc3381188bcd0903d2.zip |
Add EDOC_OPTS variable.
This is useful if edoc can't process the sources without using the
Erlang pre processor, for instance, or to pass other custom options
when building the documentation.
-rw-r--r-- | README.md | 6 | ||||
-rw-r--r-- | erlang.mk | 4 |
2 files changed, 9 insertions, 1 deletions
@@ -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 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 the `make tests` command. If your suite module is named `ponies_SUITE` then you only need to put `ponies` in the list. @@ -189,9 +189,11 @@ clean-deps: # Documentation. +EDOC_OPTS ?= + docs: clean-docs $(gen_verbose) erl -noshell \ - -eval 'edoc:application($(PROJECT), ".", []), init:stop().' + -eval 'edoc:application($(PROJECT), ".", [$(EDOC_OPTS)]), init:stop().' clean-docs: $(gen_verbose) rm -f doc/*.css doc/*.html doc/*.png doc/edoc-info |