<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body dir="auto"><div></div><div>Have a look at <a href="https://github.com/erldocs/erldocs/blob/master/src/erldocs_core.erl">https://github.com/erldocs/erldocs/blob/master/src/erldocs_core.erl</a></div><div>It already goes through the trouble of reading docs from src or doc/src and applies some transformation before rendering HTML from XML. </div><div>I have a Markdown-from-XML renderer in the works too. </div><div> <br>On 11 Mar 2016, at 08:48, Federico Carrone <<a href="mailto:federico.carrone@gmail.com">federico.carrone@gmail.com</a>> wrote:<br><br></div><blockquote type="cite"><div><div dir="ltr">Hi,<div><br></div><div>I already started working on this after getting a few useful comments from Kenneth.</div><div><br></div><div>I hope to have a simple HTML demo to get feedback from the community in one month or two. After getting feedback I will work on the pull request.</div><div><br></div><div>If you have any comments/ideas please send me an email.</div><div><br></div><div>Regards,</div><div>Federico</div><div>---</div><div><br></div><div>FYI I am using the recommendations of:</div><div><a href="http://practicaltypography.com/">http://practicaltypography.com/</a><br></div><div><br></div><div>And as Inspiration I am using:</div><div><b>Rust docs</b><br></div><div><a href="https://doc.rust-lang.org/std/slice/">https://doc.rust-lang.org/std/slice/</a><br></div><div><br></div><div><b>Python documents redesigned</b></div><div><a href="http://practicaltypography.com/python-docs-after/index.html">http://practicaltypography.com/python-docs-after/index.html</a></div><div><br></div><div><b>Racket docs</b></div><div><a href="https://docs.racket-lang.org/guide/Lists__Iteration__and_Recursion.html">https://docs.racket-lang.org/guide/Lists__Iteration__and_Recursion.html</a></div><div><br></div><div><b>Elixir docs</b></div><div><a href="http://elixir-lang.org/docs/stable/elixir/List.html#summary">http://elixir-lang.org/docs/stable/elixir/List.html#summary</a><br></div><div><br></div><div>Regards,</div><div>Federico.</div><div><br><div class="gmail_quote"><div dir="ltr">On Wed, Mar 2, 2016 at 9:58 AM zxq9 <<a href="mailto:zxq9@zxq9.com">zxq9@zxq9.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On Wednesday 02 March 2016 12:38:52 Ali Sabil wrote:<br>
> Thank you for bringing this up. An improvement to the presentation of the<br>
> Erlang documentation is very much needed.<br>
><br>
> I have started looking at this myself sometime ago, here is what I gathered:<br>
> • The OTP documentation is using erl_docgen which is mostly XSLT based<br>
> • Edoc is not that much used in OTP, the applications that do rely on<br>
> it, use a custom layout (otpsgml_layout) to generate output that can be<br>
> consumed by erl_docgen.<br>
> • Experimented with adding a modern HTML5 output to erl_docgen here:<br>
> <a href="https://github.com/asabil/otp/tree/feature/html5-docs" rel="noreferrer" target="_blank">https://github.com/asabil/otp/tree/feature/html5-docs</a> but this proved<br>
> itself challenging.<br>
> • Started working on a modern doclet for edoc, based on the ex_doc<br>
> layout: <a href="https://bitbucket.org/asabil/edoc-modern" rel="noreferrer" target="_blank">https://bitbucket.org/asabil/edoc-modern</a><br>
<br>
Hi Ali,<br>
<br>
I ran into the exact same thing and concluded it would be easier to treat<br>
rendered docs as their own data source rather than try to decobble all the<br>
mix-and-match that exists within the OTP sources themselves (though the<br>
*right* approach would be to actually make the docs across OTP uniform --<br>
I felt this would be futile to even attempt alone and unsupported, who has<br>
that much (un)paid time on their hands?).<br>
<br>
Tricky, to say the least.<br>
<br>
-Craig<br>
_______________________________________________<br>
erlang-questions mailing list<br>
<a href="mailto:erlang-questions@erlang.org" target="_blank">erlang-questions@erlang.org</a><br>
<a href="http://erlang.org/mailman/listinfo/erlang-questions" rel="noreferrer" target="_blank">http://erlang.org/mailman/listinfo/erlang-questions</a><br>
</blockquote></div></div></div>
</div></blockquote><blockquote type="cite"><div><span>_______________________________________________</span><br><span>erlang-questions mailing list</span><br><span><a href="mailto:erlang-questions@erlang.org">erlang-questions@erlang.org</a></span><br><span><a href="http://erlang.org/mailman/listinfo/erlang-questions">http://erlang.org/mailman/listinfo/erlang-questions</a></span><br></div></blockquote></body></html>