commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ralph Goers <ralph.go...@dslextreme.com>
Subject Re: [all] xdoc vs. apt
Date Tue, 18 Sep 2012 13:21:54 GMT
I did the whole Flume web site in Sphinx -  http://flume.apache.org.   It works great for documentation
but isn't really designed to build a web site - although you can.  

The Maven plugin has a few gotchas at the moment: 
1 - it has a bug that causes it to use a lot of memory on multi-module builds 
2. It can't effectively render PDFs (you can manually do this with rst2pdf). 

Ralph

On Sep 17, 2012, at 10:39 PM, S├ębastien Brisard wrote:

> Hi,
> thanks for these answers.
> I agree that apt does not seem much better than xdoc, but it at least
> offers table formatting and so on.
> So can anyone recommend a good format? Otherwise, I'm quite happy with xhtml.
> 
> An option I'm going to look at at work is sphinx [1]. It has become
> widely spread in the python community and is based on the restructured
> text format.
> More importantly (for Commons-Math), it supports formulas, either with
> dvipng (requires a local installation of LaTeX), or Mathjax (which is
> pretty good, and could also be used in xhtml).
> I can report on my experiments with this format.
> 
> Best regards,
> S├ębastien
> 
> [1] http://sphinx.pocoo.org/
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
> 


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message