How to generate EPUB documentation for Elixir v1.6

Questions / Help
1

Elixir v1.6 is now stable. I see download for stable documentation. When I download it I get only HTML Format documentation. How can I make EPUB. I’ve heard ex_doc can output EPUB Format.

It would be great to have also an EPUB download.

(download HTML, EPUB)
Elixir - standard library (HTML) (EPUB)
EEx - templating library (HTML) (EPUB)
ExUnit - unit test library (HTML) (EPUB)
IEx - interactive shell (HTML) (EPUB)
Logger - built-in Logger (HTML) (EPUB)
Mix - build tool (HTML) (EPUB)

Thank you

1 Like
2

I think You can do it by yourself…

I remember generating some phoenix docs with

$ git clone https://github.com/phoenixframework/phoenix.git 
$ cd phoenix
$ mix deps.get
$ mix docs --formatter epub

It is just a bit more complex with Elixir, because You need to update Makefile

$ git clone https://github.com/elixir-lang/elixir-lang.github.com.git 
$ git clone git://github.com/elixir-lang/ex_doc.git
$ cd ex_doc && ../elixir/bin/mix do deps.get, compile
$ cd ../elixir 

$ vim Makefile
#==> Documentation tasks
# DOCS_FORMAT = html
DOCS_FORMAT = epub

$ make docs

That might be outdated, as I did this last year with Elixir 1.5.x

2 Likes
3

yes it is outdated.

I can’t execute this line

$ cd ex_doc && …/elixir/bin/mix do deps.get, compile

1 Like
4

So… try

$ cd ex_doc && mix do deps.get, compile

And the elixir github is now

$ git clone https://github.com/elixir-lang/elixir.git
2 Likes
5

This works. But downloads Elixir-1.7.0-dev documentation. I need to figure out how to clone 1.6.0 branch.

EDIT: after cd …/elixir

$ git checkout v1.6

I think

Thank You

2 Likes