[Geoprisma-dev] Documentation : wiki or sphinx ?

[Alexandre Dube]

Yves,

Yves Moisan wrote:
>
> IMO, styling (and eventually generating a PDF or LaTeX doc) is the key
> "plus" for Sphinx.  Styling can be done with templating (Jinja).  We
> barely scratched the styling possibilities of Sphinx.  Wiki styling,
> well we pretty much know its limits ...  
>
> I'd rather build a nice Sphinx docs and point to it in the wiki (which
> I've already done) than start punching in the wiki only to find out
> several KB later that we really need a "real" docs generation tool like
> Sphinx.  I meant to write a "the files" doc that would server as a
> general "what-file-does-what" technical intro to GP.  I hope I can get
> around to doing it soon.
>
> The wiki I would use to discuss issues, develop use cases, etc.  I like
> Trac a lot better than other SCM tools because of its wiki.  At one
> point, when use cases or other Trac doc artifacts are polished enough,
> they can make it in the Sphinx docs.
>
> What others say : "Integrated wikis (like Trac) are nice; but I prefer
> to keep the documentation together with the source code. Sphinx is
> perfect for that. It also looks like a million
> bucks." (http://www.proven-corporation.com/2008/03/27/sphinx-templates/)
>
> I haven't found a quote of someone hating Sphinx, but I haven't really
> looked for that kind of thing ;-)
>
> HTH,
>
> Yves
>   

That's a strong and good opinion right there (it seems almost like a 
pretty obvious choice).  I'll go with Sphinx then.

Thanks,

-- 
Alexandre Dubé
Mapgears
www.mapgears.com