Skip to content

Switch to ex_doc for generating documentation#2

Open
fhunleth wants to merge 1 commit into
mdsebald:mainfrom
fhunleth:ex_doc-style-docs
Open

Switch to ex_doc for generating documentation#2
fhunleth wants to merge 1 commit into
mdsebald:mainfrom
fhunleth:ex_doc-style-docs

Conversation

@fhunleth

@fhunleth fhunleth commented Dec 31, 2025

Copy link
Copy Markdown

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:

image

Copilot AI review requested due to automatic review settings December 31, 2025 01:18

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@fhunleth

Copy link
Copy Markdown
Author

Sorry for the spam. I forgot that Copilot would auto-review this PR when I made it.

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