Use EDoc format internally

lfe-rebar3 / lodox

Like Codox for LFE.

http://lfe-rebar3.github.io/lodox/

MIT License

3 stars 2 forks source link

Use EDoc format internally #30

Open yurrriq opened 7 years ago

yurrriq commented 7 years ago

Right now we use a custom internal state based heavily on lfe_doc_v1 records. It might be worthwhile to adopt the EDoc record format.

Related:

OLP releases (https://github.com/lfe/olp/issues/1)
Generate docs from Erlang source (#31)

yurrriq commented 7 years ago

I'm making some progress on this locally. Too messy to commit yet, but it's looking promising. I think I'll split the lodox project into two apps:

lodox (the rebar3 plugin)
ldoc (the lfe_docs_v1 parser and EDoc generator)

yurrriq commented 7 years ago

@oubiwann, @rvirding:

Do you think I should make ldoc a separate repo, or just keep it here under apps/? Possible motivation for the former could be if a user wants to manipulate EDoc records generated from LFE source themselves, outside of Lodox.

I'm leaning toward apps/, for now anyway.

If you vote separate repo, could you create lfex/ldoc and give me admin privileges?

yurrriq commented 7 years ago

It might also be good to split out the forthcoming markdown, JSON and text writers into their own repos. Those belong in the lfe-rebar3 org, I think. I figure lodox-{{format}} is a good naming scheme, if we decide to do that.

yurrriq commented 7 years ago

Hmm, on second thought, we probably won't need a rebar3 plugin anymore, since I'm writing an EDoc doclet module in ldoc...