Support for excluding modules?

[oubiwann]

There are some modules I won't want included in a public API (e.g., modules that bring in functions defined in C ports, for which there are friendlier, "public" modules).

Could you add a configuration file (or flag) option for excluding modules from the generated docs?

[yurrriq]

I'm working on a configuration revamp right now. How would you feel about something like this in the config:

{'excluded-modules',
  ['secret-mod', 'private-mod', 'excluded-mod']}

^ a list of module names to exclude.

[oubiwann]

Yeah, that's the sort of thing I was thinking.

If this goes in the rebar.config file (possible? I hope so...), I'd add lodox context, e.g.:

{lodox [{'excluded-modules',
         ['secret-mod','private-mod','exlcuded-mod']}]}.

This leaves a whole bunch of nice possibilities for lodox in the future (configurability for things we can't think of right now).

If rebar3 barfs on having extraneous data in rebar.config, I'd opt for using lfe.config ... since it'd be a shame to have a proliferation of configuration files in LFE projects ...

[yurrriq]

That's exactly what I've got cooking. 😄

[oubiwann]

SWEEEEET! ❤️

[yurrriq]

This needs to be cleaned up and documented, but the basic functionality is there.

[yurrriq]

• Include this example

[yurrriq]

Moved to lfe-rebar3#18.