From acfa33561cc06e7a085420fc3381188bcd0903d2 Mon Sep 17 00:00:00 2001 From: Andreas Stenius Date: Wed, 9 Oct 2013 11:10:01 +0200 Subject: 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. --- README.md | 6 ++++++ erlang.mk | 4 +++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 00711a4..e01761b 100644 --- a/README.md +++ b/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 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. diff --git a/erlang.mk b/erlang.mk index d5fa2aa..9a658bc 100644 --- a/erlang.mk +++ b/erlang.mk @@ -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 -- cgit v1.2.3