[erlang-questions] Documentation build process: creating DocBook XML?

Matt Kangas <>
Mon Feb 11 21:11:05 CET 2008


Dear Erlang team, and erlang-questions readers,

I have some questions about the Erlang *documentation* build process.  
I'll list my questions first, then explain my reasons for asking...

Questions:

1) What makefile targets are used to build the HTML documentation from  
source?
Given an Erlang source tarball, can I build all of http://www.erlang.org/doc/ 
  myself?

2) Which tools are used to generate which parts of the documentation?
I've discovered "docbuilder" and "edoc" so far. What else gets called  
by make to crank out the doc tree?

3) What module(s) would I have to hack in order to add another output  
format to the documentation generator? Any advice on how to start? :-)


Motivation:

I'd like to see if put together an "improved" version of the current  
docs: same content, better presentation. Specifically, I'd like to try  
putting the Erlang docs inside the PHP documentation framework, as  
outlined here:

http://www.p16blog.com/p16/2008/02/user-added-comm.html

DocBook XML is the format I'd need to generate. It's a popular doc- 
source format for open-source projects, so even if PHP's framework  
proves unsuitable, several other doc frameworks should be directly  
usable.

If I make any progress, I'll gladly contribute all code back to the  
community. :-)

Thanks in advance,
--Matt Kangas

-- 
Matt Kangas
 – www.p16blog.com




More information about the erlang-questions mailing list