Hi all, Continuing with discussion from the "GeoTools 2.6.4 Released" side thread about documentation.
So the consencus seems to be to have a top level doc module that would have three submodules: doc/ user/ devel/ web/ I agree that this is probably the easiest way forward. Having docs specific to each module could be a little tricky with sphinx, so I vote to keep it simple for a first pass. Also the current set up used to generate the docs on the osgeo hardware is not really working for folks since it runs as a cron job with my user :) So I propose the following: 1. Integrate the doc generation into the maven build. This would involve adding a new profile (called doc) and some maven hacking to invoke sphinx. If people would like we could do this in a way that would not fail when sphinx is installed on the system. It would simply just not build the docs. Or perhaps we do want to fail so it's explicit. I guess this makes sense if people are going to be explicitly invoking the profile. Integrating into the maven build has the nice side effect of making it easy to keep version numbers in sync. Basically the version in the sphinx docs would always be same as the version declared in the pom file. 2. Update the assembly process to create -doc artifacts for the user and developer guides. These artifacts would be mostly for release purposes. 3. Add the doc generation to the opengeo hudson build server. This would give us continuous builds on docs. On each build we could upload the resulting docs to the osgeo box (or wherever we decide to host them). Thoughts and opinions welcome. I can write up a proposal if need be but want to get some initial feedback first. -Justin -- Justin Deoliveira OpenGeo - http://opengeo.org Enterprise support for open source geospatial. ------------------------------------------------------------------------------ _______________________________________________ Geotools-devel mailing list Geotools-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/geotools-devel
