Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move types to modules, generate docs with rebar3_ex_doc #130

Merged
merged 6 commits into from
Jul 30, 2023

Conversation

rkallos
Copy link
Contributor

@rkallos rkallos commented Jul 27, 2023

This PR started out as an experiment to switch from using edown to using rebar3_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 the shackle 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 like python3 -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 running rebar3 hex publish.

@rkallos rkallos force-pushed the remove-type-duplication branch from 348903d to c334b8c Compare July 27, 2023 19:12
@lpgauth
Copy link
Owner

lpgauth commented Jul 29, 2023

@rkallos can you rebase off master? thanks!

@rkallos rkallos force-pushed the remove-type-duplication branch from c334b8c to 53ec323 Compare July 30, 2023 00:14
@rkallos
Copy link
Contributor Author

rkallos commented Jul 30, 2023

Done!

@lpgauth lpgauth merged commit 2ed77e3 into lpgauth:master Jul 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants