launchpad-dev team mailing list archive

[Julian Edwards <julian.edwards@xxxxxxxxxxxxx>]

On Thursday 06 October 2011 11:34:59 Matthew Revell wrote:
> On 6 October 2011 11:27, Julian Edwards <julian.edwards@xxxxxxxxxxxxx> 
wrote:
> > On Thursday 06 October 2011 10:14:10 Matthew Revell wrote:
> >> Now, as for whether we favour Sphinx docs or doctests, I'm a little
> >> less clear on. I prefer the Sphinx stuff because anyone can access
> >> them via rtfd. However, my experience with doctests is pretty limited.
> > 
> > Talking of R[F]TD, I'd much rather we had docs.launchpad.net and host it
> > ourselves.
> 
> Would a redirect from docs.launchpad.net to launchpad.readthedocs.org be
> enough?
> >From a branding and general feel-good point of view, I get the idea
> 
> that hosting it ourselves and branding it nicely would be a good thing
> but it depends how much other stuff would have to wait while we did
> that.

I'd think it was ok temporarily but I don't think we should be relying on an 
external service when pushing out static pages is utterly trivial (relatively 
speaking).

> 
> >  * MOIN SUCKS
> >  * Doctests blow (I personally think they have a place, just a limited
> > one) * rST is portable
> >  * Docs in the tree are desirable, using Sphinx.
> >   * Caveat - landing to LP is heavyweight, but Matthew thinks this is a
> > benefit to have it reviewed. (I agree)
> >  * Wikkid is nice. (having docs in a separate tree for it might be a
> > compromise between LP's heavy landing process and reviewability)
> 
> I am pretty heavily in favour of having the same review process and
> commit rights for landing docs. Losing the four hour (soon to be
> shorter!) test suite just for a doc change might be nice, though.

Yes, that was my point :)  Docs don't need testing.

J