[Geotools-devel] Site building changes committed

[Andrea A. <aa...@op...>]

Hi,
quick mail for a quick report.
The site building changes have been committed.

You can check for yourself how the generated site looks like by 
connecting to:
http://sigma.openplans.org/~aaime/gtsite/index.html
As you can see, it contains per module javadoc, cross
referenced sources in html format, cobertura and findbugs
reports. The review link on top works only if the current
module has a review.apt in its src/site/apt directory
(works for most modules, not for the ones that are
just grouping other modules).

The javadoc aggregation works as well, provided you use
mvn javadoc:aggregate instead of javadoc:javadoc (the
release guide needs amending).
Preview of the aggregated javadocs here:
http://sigma.openplans.org/~aaime/apidocs/

If you want to try generating the site on your PC,
all that should be needed is java 5 and Maven 2.1
 From the root run:
mvn site
mvn site:deploy -Psite.local

or, alternatively (but I haven't tried this one so far):
mvn site-deploy -Psite.local

and you should get the site generated and wired
in ${java.io.tempdir}/gtsite (if on a *nix, it
will probably be /tmp/gtsite).

Mind, the site generation takes a while and generates
a lot of output, on my pc it takes 30 minutes and
the generated site is almost 600MB.

If you want to try out javadoc aggregation you
can run:
mvn javadoc:aggregate

The result will be in target/site/apidocs. It's quite
a bit faster, on my PC it's around 2 minutes, and the
generated output is a bit less than 200MB.

(mind, my PC has been running site and javadoc generation
all the afternoon, so it's basically not touching the
disk at all to generate the contents, so expect longer
times on yours).

Feedback appreciated

Cheers
Andrea

-- 
Andrea Aime
OpenGeo - http://opengeo.org
Expert service straight from the developers.