Generating docs with ExDoc instead of EDoc

cw789 commented 2 years ago

Clean new PR replacing https://github.com/gen-smtp/gen_smtp/pull/290.

Additionally this PR removes code meant for < OTP 21. Additionally this PR introduces format checking in CI. This part is probably opinionated if task should be allowed to fail until every maintainer is used to check the format beforehand.

I've added the usage of ex_doc & fmt to the Makefile as a kind of documentation. For myself it is not 100% clear how I could make sure I use the latest rebar3 plugin as they are not anywhere pinned. -> Upgrading Plugins This also means I'm not sure how reproducible the CI is regarding the plugins.

All the best.

seriyps commented 2 years ago

I think plugins can be pinned same way as dependencies:

{project_plugins, [
    {erlfmt, "1.0.0"},
    {rebar3_proper, "0.12.1"}
]}.

Don't know why I haven't done it initially…

mworrell commented 2 years ago

@cw789 Thanks!

cw789 commented 2 years ago

Thank you too. Hope it doesn't bring any burden to the one who do releases.

gen-smtp / gen_smtp

Generating docs with ExDoc instead of EDoc #308