Hi all, Andrea and I talked a bit today about having Sphinx documentation for community modules. Here's a transcript; hopefully we can finish up this discussion on the mailing list.
12:23 < aaime> jdeolive, community modules and documentation... confluence? I guess I'd like it better to write direclty in sphinx, but we don't have a place there 12:23 < aaime> (I guess we could make it) 12:24 < dwins> i've been meaning to bring this up too; i have a few pages on the rhino extension that i wrote up in sphinx 12:24 < aaime> We have a tutorial section, we could have a "community" or "preview" section 12:25 < aaime> it's important that we make it clear that the modules are not part of the standard distribution though 12:25 < aaime> otherwise, confluence until the module gets supported, and then we have to redo all the formatting (syntax change) to port over to sphinx 12:25 < aaime> the downside of using sphinx is that the official release docs would still contain the community modules stuff... 12:26 < aaime> is there a way to exclude bits and pieces from a sphinx build? 12:26 < dwins> i know you can have conditionals inside a document 12:26 < dwins> i don't know whether you can completely hide subtrees 12:29 < dwins> http://sphinx.pocoo.org/ext/ifconfig.html 12:29 < sigq> Title: sphinx.ext.ifconfig – Include content based on configuration Sphinx v0.6.4 documentation (at sphinx.pocoo.org) 12:30 < aaime> sounds interesting 12:30 < aaime> generally speaking I guess would be nice to be able and do something like 12:31 < aaime> make html -Prelease 12:31 < aaime> (mixing mvn and make syntax) 12:31 < aaime> so that the whole community subtree gets excluded 12:31 < aaime> well, I don't have to work on this right now, but we can copy this chat and send it to the devel ml? 12:32 < aaime> dwins? 12:32 < dwins> sounds good to me 12:32 < aaime> cool, you do it? :-p 12:32 < dwins> okay, i will 12:32 < aaime> thanks!!! 12:32 < dwins> before you go though 12:32 < aaime> uh? 12:32 < dwins> i think it would be easier to keep them as separate sphinx projects 12:33 < dwins> and use intersphinx if we need to link to 'official' pages from the community docs -- David Winslow OpenGeo - http://opengeo.org/ ------------------------------------------------------------------------------ SOLARIS 10 is the OS for Data Centers - provides features such as DTrace, Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW http://p.sf.net/sfu/solaris-dev2dev _______________________________________________ Geoserver-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geoserver-devel
