Ticket #4569 enhancement closed fixed

Opened 3 years ago

Last modified 3 years ago

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
Author: jdb Launchpad Bug:

Description

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

Attachments

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

Change History

1

Changed 3 years ago by khorn

  • milestone set to Lore to Sphinx

Changed 3 years ago by jdb

2

Changed 3 years ago by jdb

  • status changed from new to closed
  • resolution set to fixed

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.

3

Changed 3 years ago by exarkun

  • status changed from closed to reopened
  • resolution fixed deleted

4

Changed 3 years ago by exarkun

  • keywords review documentation added
  • status changed from reopened to new
  • owner glyph deleted

5

Changed 3 years ago by exarkun

  • owner set to jdb
  • keywords review removed

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.

6

Changed 3 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 3 years ago by jdb

7

Changed 3 years ago by glyph

  • branch set to branches/tutorial-lore2sphinx-4569
  • branch_author set to glyph

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

8

Changed 3 years ago by glyph

9

Changed 3 years ago by exarkun

(In [30078]) Undo a typo introduced

refs #4569

10

Changed 3 years ago by exarkun

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

refs #4569

11

Changed 3 years ago by exarkun

(In [30080]) Same again

refs #4569

12

Changed 3 years ago by exarkun

  • owner set to exarkun
  • keywords review removed
  • branch_author changed from glyph to jdb

With the above extra fixes, looks good.

13

Changed 3 years ago by exarkun

  • status changed from new to closed
  • resolution set to fixed

(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.

14

Changed 2 years ago by <automation>

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