[erlang-questions] Erlang documentation -- a modest proposal

Martin Karlsson <>
Tue Sep 27 13:03:39 CEST 2016


Hi guys,

> Interesting would be to know how many % of the users that actually are
using the man and pdf pages.
The man pages is the erlang documentation I use the most. In fact I Iike
them so much I had to reply to this thread to reduce the risk of them going
away :). They are much quicker than anything if you have a console based
work-flow. I even miss the man pages for all external libraries. I would
love if there was a common erlang documentation system making it easy for
external libraries to produce the same style and type of documentation as
the official documentation.

I am not overly attached to a documentation system but there are a few that
does conversion to lots of formats with good quality, for example sphinx
which can generate html, latex, man pages, epub among others.

A final comment regarding html generated documentation. Please don't rely
on javascript for more than enhancing the experience. I see lots of modern
html documentation which doesn't display all data (for example code
examples) or can't do navigation without javascript.

Cheers,
Martin
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20160928/d459bfc5/attachment.html>


More information about the erlang-questions mailing list