dkotrada

dkotrada

How to generate EPUB documentation for Elixir v1.6

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

Most Liked

kokolegorille

kokolegorille

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

kokolegorille

kokolegorille

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
dkotrada

dkotrada

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

Where Next?

Popular in Questions Top

New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
JulienCorb
I am trying to implement my new.html.eex file to create new posts on my website. new.html.eex: <h1>Create Post</h1> <%= ...
New
freewebwithme
Using vs code and installed ElixirLS: support and debugger. And I got an error popped up on start up says Failed to run ‘elixir’ comma...
New
RisingFromAshes
I’ve read in another post that it may be possible with a router helper - but I couldn’t find an appropriate one, and tbh, I’m still just ...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
joaquinalcerro
Hi there, I am working with Ecto-Postgresql and I need to call all of the records from a specific table but the table has 40,000 records...
New
PeterCarter
There are pre-rolled solutions for other frameworks that do work. However, Phoenix does not seem to have these. Have people had good expe...
New
earth10
Hi, I’m just starting to build a side-project with Elixir and Phoenix and doing some basic test with Elixir alone. What strikes me is th...
New
vegabook
I’m brand new to Phoenix and I have stripped one of the demo applications to the bone. I just want to get an svg up on the screen. Here i...
New

Other popular topics Top

axelson
This post is a wiki (feel free to hit the edit button near the bottom right of this post to add your own changes!) This post collects co...
239 48475 226
New
danschultzer
None of the current solutions worked well for me, so I went ahead and built a user management system from scratch. This project took far...
548 29703 241
New
malloryerik
Hi, this is for people who, like me, have had some friction using .html.heex templates in VSCode. The solution seems to be, in a hyphena...
New
senggen
Erlang/OTP 25 [erts-13.2.2] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] 15:22:35.803 [error] gen_event {lager_file_backend...
New
siddhant3030
Hi, I have to write a raw query for one of my project. But till now I have used ecto queries and don’t have much experience writing raw ...
New
albydarned
Hello all! I am typing this post from my new MacBook Pro with the M1 chip. I’m loving it so far, and will probably use it as my daily dr...
New
shahryarjb
Hello, I have map which I want to convert it to string like this: the map: %{last_name: "tavakkoli", name: "shahryar"} the string I ne...
New
AstonJ
Please see the new poll here: Which code editor or IDE do you use? (Poll) (2022 Edition) It’s been a while since we first asked this, I...
208 31307 143
New
sergio_101
I am VERY much an elixir newbie. I have taken one elixir course and one phoenix course on Udemy. During that course, I saw the instructor...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New

We're in Beta

About us Mission Statement