Closed zachdaniel closed 4 years ago
We should figure out how documentation is going to work. Will we need something custom to wrap around both mix and rebar3 generated docs or can mix generate them all?
Thats a great question :)
It doesn't look like mix can do it :(
You can link to "extra" pages though, so we could potentially just link to the erlang doc pages
We can just generate them to separate sub-directories and have a index.html that links to each.
Finally catching up on this - is the intention that we'd have both Elixir and Erlang code in this repo and publish it to Hex as an Elixir package that also has Erlang code in it, or would we publish the Erlang code as one package and the Elixir code as a separate package that uses the Erlang one? I'm not really familiar with how rebar3 pulls in dependencies and if it would be mad that there's also Elixir code in there, or if it would know how to ignore the Elixir parts.
@GregMefford it would be published as one package with the build_tools
field set to both rebar3
and mix
and include all the necessary directories. Then only when built in a mix project will it build the elixir parts.
I signed it
This is a draft just to confirm the general pattern of the Elixir API as it relates to the erlang API.