Re: Can't generate Elixir docs

55 views
Skip to first unread message

José Valim

unread,
Oct 21, 2012, 5:42:38 PM10/21/12
to elixir-l...@googlegroups.com
Hello Heige, the documentation generation is kind of a private tool like now because it is not as polish as it should be.
If you just want the docs, you can get the latest from https://github.com/elixir-lang/elixir-lang.github.com/tree/master/docs and use it for fun and profit.

Now, assuming you actually want to hack around the documentation, I have just given it a run and it worked fine.
That said, I have the following recommendations:

1) Get elixir master and recompile it (`make test` is probably enough)
2) Get exdoc master and recompile it (`mix do clean, compile` is probably enough)
3) Run `make docs` again

Let me know how it works. If you have any questions, feel free to send it here and join us at #elixir-lang irc.freenode.net :)

On Sunday, October 21, 2012 10:56:15 PM UTC+2, Helge wrote:
Hi,

I'm trying to generate the Elixir docs by using 'make docs', but I'm getting this error:

make docs
mkdir -p ebin
rm -rf docs
cp -R -f lib/*/ebin/*.beam ./ebin
bin/elixir ../exdoc/bin/exdoc
** (ArgumentError) argument error
    /Users/helge/Development/exdoc/lib/ex_doc/retriever.ex:54: ExDoc.Retriever.nest_modules/4
    /Users/helge/Development/exdoc/lib/ex_doc/retriever.ex:30: ExDoc.Retriever.get_docs/2
    /Users/helge/Development/exdoc/lib/ex_doc.ex:7: ExDoc.generate_docs/2
    src/elixir_compiler.erl:77: :elixir_compiler."-code_loading_compilation/6-fun-0-"/5
    src/elixir_compiler.erl:76: :elixir_compiler.code_loading_compilation/6
    src/elixir_compiler.erl:30: :elixir_compiler.string/2
    /Users/helge/Development/elixir/lib/elixir/lib/code.ex:208: Code.require_file/2
    /Users/helge/Development/elixir/lib/elixir/lib/enum.ex:479: Enum."-map/2-lc$^0/1-0-"/2

Any idea how to fix this?

Thanks in advance,

Helge

Helge

unread,
Oct 22, 2012, 8:52:44 AM10/22/12
to elixir-l...@googlegroups.com
Hello José,

Thanks for replying so quickly. I have followed your steps, but it make docs still generates the same error. Maybe it's a path/url issue. I'll have a look into that at the weekend. Anyway, I've downloaded the docs to have them while commuting.

Thanks,

Helge
Reply all
Reply to author
Forward
0 new messages