Skip to content

SimonBaeumer/doc-test-examples

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doc testing in elixir

Example elixir module which uses document testing

Docker

docker run -it -v $(pwd):/app elixir:1.8 /bin/bash

Installation

Installation guide: https://elixir-lang.org/install.html#distributions

# Install dependencies
mix deps

# Run doc tests
mix test

# Generate docs
mix docs
chromium-browser doc/index.html

About

Example repository for generating elixir documentation with example tests

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published