Opened 4 years ago

Closed 4 years ago

#4569 enhancement closed fixed (fixed)

Improve lore2sphinx buildbot results for `projects/core/howto/tutorial`

Reported by: khorn Owned by:
Priority: normal Milestone: Lore to Sphinx
Component: core Keywords: documentation
Cc: Branch: branches/tutorial-lore2sphinx-4569
(diff, github, buildbot, log)
Author: jdb Launchpad Bug:

Description

like #4566, except for projects/core/howto/tutorial

Attachments (2)

tutorial.xhtml.patch (6.7 KB) - added by jdb 4 years ago.
tutorial2.xhtml.patch (18.1 KB) - added by jdb 4 years ago.

Download all attachments as: .zip

Change History (16)

comment:1 Changed 4 years ago by khorn

  • Milestone set to Lore to Sphinx

Changed 4 years ago by jdb

comment:2 Changed 4 years ago by jdb

  • Resolution set to fixed
  • Status changed from new to closed

Modified the xhtml input (made sure no <code> or <em> tag begins a newline), to correct the rst output. In the directory core/howto/tutorial/, the files intro.xhtml, protocol.xhtml and web.xhtml were modified. Now, there is no more missing space between a word and either or .

lore2sphinx does not copy the python code listings from the lore input directory to the rst output directory. When the listings are copied by hand in the rst directory, the listings appear correctly in the final html pages.

comment:3 Changed 4 years ago by exarkun

  • Resolution fixed deleted
  • Status changed from closed to reopened

comment:4 Changed 4 years ago by exarkun

  • Keywords review documentation added
  • Owner glyph deleted
  • Status changed from reopened to new

comment:5 Changed 4 years ago by exarkun

  • Keywords review removed
  • Owner set to jdb

Unfortunately the patch file appears to be corrupted.

exarkun@boson:~/Projects/Twisted/trunk$ patch -p1 < tutorial.xhtml.patch 
patch: **** Only garbage was found in the patch input.

comment:6 Changed 4 years ago by jdb

  • Keywords review added
  • Owner jdb deleted

The latest patch applies correctly to the latest trunk:

$ svn checkout svn://svn.twistedmatrix.com/svn/Twisted/trunk
$ cd trunk
$ svn status
?       tutorial2.xhtml.patch

$ patch -p0 < tutorial.xhtml.patch 
patching file doc/core/howto/tutorial/intro.xhtml
patching file doc/core/howto/tutorial/protocol.xhtml
patching file doc/core/howto/tutorial/web.xhtml

$ svn status
?       tutorial.xhtml.patch
M       doc/core/howto/tutorial/intro.xhtml
M       doc/core/howto/tutorial/web.xhtml
M       doc/core/howto/tutorial/protocol.xhtml

Changed 4 years ago by jdb

comment:7 Changed 4 years ago by glyph

  • Author set to glyph
  • Branch set to branches/tutorial-lore2sphinx-4569

(In [30076]) Branching to 'tutorial-lore2sphinx-4569'

comment:9 Changed 4 years ago by exarkun

(In [30078]) Undo a typo introduced

refs #4569

comment:10 Changed 4 years ago by exarkun

(In [30079]) Fix another case where the conversion gets confused

refs #4569

comment:11 Changed 4 years ago by exarkun

(In [30080]) Same again

refs #4569

comment:12 Changed 4 years ago by exarkun

  • Author changed from glyph to jdb
  • Keywords review removed
  • Owner set to exarkun

With the above extra fixes, looks good.

comment:13 Changed 4 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

(In [30082]) Merge tutorial-lore2sphinx-4569

Author: jdb
Reviewer: exarkun
Fixes: #4569

Tweaks to the Lore markup in the core tutorial to make it more amenable to conversion to Sphinx.

comment:14 Changed 3 years ago by <automation>

  • Owner exarkun deleted
Note: See TracTickets for help on using tickets.