Step 5: Create Project Documentation
Understand how to create comprehensive project documentation in Elixir using ExDoc. Learn to configure dependencies, generate HTML documentation, and link to source code. This lesson helps you organize your project documentation effectively while exploring how documentation complements data transformation and testing in Elixir development.
We'll cover the following...
We'll cover the following...
Java has Javadoc, Ruby has RDoc, and Elixir has ExDoc. These are documentation tools that describe our project by showing the modules, the things defined in them, and any documentation we’ve written for them.
Using it is easy. First, we add the ExDoc dependency to the mix.exs file. We’ll also need to add an output formatter. We use earmark, a pure Elixir Markdown-to-HTML convertor.