mix style documentation #6
Merged
Conversation
This file contains hidden or 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
Documentation generation based on hex.pm publishing documentation recomendaton. Provide using rebar3_ex_doc functionality. We have an option to generate mix style documetation of a Erlang library. To do so just run `rebar3 ex_doc --logo doc/img/logo.png --output edoc` command and check a result.
Add information related to documentation generation.
Add logo image.
Add logo image.
Add ignoring edoc folder
Add an option to generate Exdoc to make file. Tune README.md.
Member
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Documentation generation based on hex.pm publishing documentation recomendations using rebar3_ex_doc functionality. We have an option to generate mix style documetation of an Erlang library.
It possible to have two types of documentation view (Edoc and ExDoc). To generate ExDoc just run
command and check a result.