Skip to content

Commit

Permalink
Add info on mix docs to README
Browse files Browse the repository at this point in the history
  • Loading branch information
stuartc committed Mar 23, 2022
1 parent 901502b commit 25d5945
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,8 @@ In addition to our test suite, you can run the following commands:
> For convenience there is a `verify` mix task that runs all of the above and
> defaults the `MIX_ENV` to `test`.
## Generating Documentation

You can generate the HTML and EPUB documentation locally using:

`mix docs` and opening `doc/index.html` in your browser.

0 comments on commit 25d5945

Please sign in to comment.