I didn't anticipate much opposition to using sphinx, so I have actually been working on some docs in odd hours since the git migration (which broke our older sphinx setup, which depended on svn somehow.) Anyway, check out what I've got here:
http://github.com/dwins/geonode/compare/master...sphinx-docs "paver html" puts the manual in docs/_build/html/, or you can use make if you are like me and have a handy 'jump to errors from make' feature in your editor. -- David Winslow OpenGeo - http://opengeo.org/ On 07/14/2010 11:18 AM, David Winslow wrote: > Hey guys, > > GeoServer uses Sphinx (http://sphinx.pocoo.org/) to maintain user and > developer manuals. > GeoExt uses Sphinx to maintain a user/client developer manual (and has a > JavaScript API extraction tool we could use too). > Django uses Sphinx to maintain a developer manual. > > It works really well for all of these projects, I say we hop on this > bandwagon too. Any objections? > > Regardless of the technology choice I am thinking that we should create > a single manual aimed at *developers* and *site maintainers.* Topics > covered would include getting a build started, the map configuration > system, Django views, customizing map viewers, deployment concerns, etc. > > Documentation for implementers (feature specs, proposals, etc.) would > continue to be maintained in a wiki. > > -- > David Winslow > OpenGeo - http://opengeo.org/ >
