[OpenLayers-Dev] Docs Refactored to use Sphinx
Christopher Schmidt
crschmidt at metacarta.com
Tue Dec 23 18:56:49 EST 2008
On Tue, Dec 23, 2008 at 04:42:05PM -0700, Tim Schaub wrote:
> Hey-
>
> Christopher Schmidt wrote:
> > After playing with Sphinx for a couple other reasons, I have decided
> > that not using Sphinx for our documentation builds was a complete
> > mistake, and have changed the OpenLayers build process to use it.
> >
> > What this means:
> >
> > * The URLs or the docs we had have now changed, as has the layout,
> > slightly. I'm sorry for that, but hopefully it will be a one-time
> > change.
> >
> > * The docs can easily be built with Sphinx. Simply:
> >
> > easy_install Sphinx (possibly with sudo)
> > svn co http://svn.openlayers.org/trunk/doc
> > cd doc
> > make html
> >
> > This will create a directory of documentation for you.
> >
>
> Nice! Thanks for the work on this Chris.
>
NP. You suggested sphinx the first time around, I should have listened
more strongly, but was concerned about getting "look and feel" right
within the sphinx framework. (This ended up not being too difficult, in
the end.)
Regards,
--
Christopher Schmidt
MetaCarta
More information about the Dev
mailing list