[Twisted-Python] twisted.web in 60 seconds...why aren't these on the frontpage of TM.com?

Kevin Horn kevin.horn at gmail.com
Thu Apr 22 13:07:05 EDT 2010

On Thu, Apr 22, 2010 at 11:51 AM, <exarkun at twistedmatrix.com> wrote:

> On 02:57 pm, kevin.horn at gmail.com wrote:
> >On Wed, Apr 21, 2010 at 9:48 PM, <exarkun at twistedmatrix.com> wrote:
> >>
> >>So about the conversion, I wonder if we can start to generate the
> >>Sphinx
> >>version of the docs on buildbot sometime soon, and perhaps host them
> >>alongside the current docs, as the first step in phasing out the
> >>current
> >>version?
> >
> >I suppose we could do this, if you think it would help.  Note that the
> >lore2sphinx
> >script requires Python 2.6 and I think at least Sphinx 0.6.4 (I'm using
> >0.6.5).
> Shouldn't be a problem.
> >
> >>
> >>How automated is the conversion process now?  Are errors reported such
> >>that people could start looking at them and fixing the issues?  It
> >>seems
> >>like you've done almost all of the hard work, and the rest is dealing
> >>with some edge cases in lore or restructured text, and that might be
> >>more easily spread out amongst more people.
> >>
> >>Jean-Paul
> >I think the automatic conversion process has reached the point of
> >diminishing returns.
> >I've got it down to about 13 warnings in the Sphinx build process,
> >though
> >there are still
> >some markup errors in the output.  Trying to make the conversion handle
> >these seems
> >to just introduce more errors in other places.
> Would it be easier to fix these by changing the lore sources?
> Jean-Paul
I seriously doubt it.  In fact I think it would be much more difficult.

Other than the 13 build warnings I mentioned above, almost all of the
rest of the markup errors are things like a missing space character.

Fixing this in the lore sources would require:
1) removing most if not all indentation from all the lore sources
2) making sure every <b>, <i>, <code>, <a> tag (and some others I'm sure)
   have exactly the same spacing before and after them...including tabs,
newlines, etc.
3) revamping lore2sphinx to stop doing all the workarounds it currently does

I think it will be much easier to go through the ReST sources (which IMO
will need to
be done anyway) and add spaces or whatever where needed.

Kevin Horn

Kevin Horn
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://twistedmatrix.com/pipermail/twisted-python/attachments/20100422/6f56d3db/attachment.htm 

More information about the Twisted-Python mailing list