[erlang-questions] HTML/CSS/Javascript in Erlang docs and Common Test

Ali Sabil <>
Wed Mar 2 13:38:52 CET 2016


Thank you for bringing this up. An improvement to the presentation of the
Erlang documentation is very much needed.

I have started looking at this myself sometime ago, here is what I gathered:
    • The OTP documentation is using erl_docgen which is mostly XSLT based
    • Edoc is not that much used in OTP, the applications that do rely on
it, use a custom layout (otpsgml_layout) to generate output that can be
consumed by erl_docgen.
    • Experimented with adding a modern HTML5 output to erl_docgen here:
https://github.com/asabil/otp/tree/feature/html5-docs but this proved
itself challenging.
    • Started working on a modern doclet for edoc, based on the ex_doc
layout: https://bitbucket.org/asabil/edoc-modern


Hope this helps.

Cheers,
Ali

On Wed, Mar 2, 2016 at 1:05 PM Jean Parpaillon <>
wrote:

> mkdocs is used for generating documentation suitable for, for instance,
> readthedocs.org platform.
>
> I've had started a mkdocs doclet module some time ago but it is stalled
> now. At that time, I was not really familiar with xmerl, and this is
> one of the reasons I've not continued.
>
> Anybody interested in going on ?
> https://github.com/erocci/edoc_mkdocs
>
>
> Cheers,
> Jean
>
>
> Le mercredi 02 mars 2016 à 16:37 +0900, zxq9 a écrit :
> > On Wednesday 02 March 2016 11:15:04 Leo Liu wrote:
> > > On 2016-03-01 23:53 +0000, Federico Carrone wrote:
> > > > I am sure this is not a priority for most developers. However I
> > > > do
> > > > think this type of things are important for some newcomers.
> > >
> > > I think it is very important to the Erlang community. The bar has
> > > been
> > > raised so high that there is no excuse not to make the
> > > documentation
> > > pleasant to read. Hope there is a way to facilitate your
> > > contribution.
> >
> > I've wished I had time to do the same. If you actually *do* have time
> > to
> > work on this it would be great (and if you need a hand, ASK -- I've
> > mentioned it more than once, just never got around to doing
> > anything).
> >
> > You may be able to create a pull request directly against the OTP
> > project on github. Maybe not.
> >
> > Anyway, good luck!
> >
> > -Craig
> > _______________________________________________
> > erlang-questions mailing list
> > 
> > http://erlang.org/mailman/listinfo/erlang-questions
> --
> Jean Parpaillon
> --
> Director @ OW2 Consortium
> OCCIware Strategic Orientation Committee Chairman
> Research Engineer @ Inria
> --
> Phone: +33 6 30 10 92 86
> im: 
> skype: jean.parpaillon
> linkedin: http://www.linkedin.com/in/jeanparpaillon/en
>
> _______________________________________________
> erlang-questions mailing list
> 
> http://erlang.org/mailman/listinfo/erlang-questions
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20160302/7c40695d/attachment.html>


More information about the erlang-questions mailing list