Move types to modules, generate docs with rebar3_ex_doc #130
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR started out as an experiment to switch from using
edown
to usingrebar3_ex_doc
for generating documentation.The resulting documentation showed that each module that directly or transitively included
shackle.hrl
had its own copy of the type declarations in that header file. To clean that up, I moved the type declarations to the modules that seemed the most appropriate. Another option might be to export all types from theshackle
module. I'd be happy to make those changes if that's what you'd prefer.You can generate the docs by running
rebar3 ex_doc
, running a HTTP server (I likepython3 -m http.server
) and navigating into/doc
in a web browser.If these instructions are to be believed, publishing docs to Hexdocs is as straightforward as running
rebar3 hex publish docs
after successfully runningrebar3 hex publish
.