Generating docs with ExDoc instead of EDoc #308
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Uses the rebar3 plugin `rebar3_ex_doc`. Can be used by `rebar3 ex_doc`.
|
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… |
cw789
commented
Feb 12, 2022
| - name: Build EDoc | ||
| run: make docs | ||
| - name: Generate docs by ExDoc | ||
| run: rebar3 ex_doc |
There was a problem hiding this comment.
The run command could have stayed the same, now as I also changed the Makefile.
mworrell
approved these changes
Feb 14, 2022
|
@cw789 Thanks! |
|
Thank you too. Hope it doesn't bring any burden to the one who do releases. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Clean new PR replacing #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&fmtto 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.