Switch to ex_doc for generating documentation#2
Open
fhunleth wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR migrates the documentation system from edoc to ex_doc for the cerlc library, which generates CRC (Cyclic Redundancy Check) functions in Erlang.
- Adds rebar3_ex_doc plugin configuration to rebar.config
- Removes the old doc/overview.edoc file that was used by edoc
- Updates README.md with improved formatting, minor fixes, and documentation generation instructions
- Updates .gitignore to ignore the /doc directory instead of individual edoc artifacts
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| rebar.config | Adds rebar3_ex_doc as a project plugin with configuration for source URL, main page, and extras |
| doc/overview.edoc | Removes the entire edoc overview file as part of migration to ex_doc |
| README.md | Reformats content, fixes Elixir example syntax, and adds new section explaining how to generate docs with ex_doc |
| .gitignore | Updates to ignore /doc directory instead of individual edoc-info file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
0b185ce to
5dd97ed
Compare
Author
|
Sorry for the spam. I forgot that Copilot would auto-review this PR when I made it. |
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
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.
I tried to make the smallest amount of changes to the README.md. They were mostly to fix Markdown to render better with ex_doc. It looks like this: