Opened 7 years ago

Closed 6 years ago

#2940 enhancement closed fixed (fixed)

Need first-class man .xhtml generation code

Reported by: radix Owned by:
Priority: highest Milestone: twisted-8.0
Component: release management Keywords:
Cc: therve Branch: branches/man-builder-2940
(diff, github, buildbot, log)
Author: therve Launchpad Bug:

Description

admin/process-docs generates .xhtml and then .html files from our man pages. We need to do this in a way that's well -tested and -documented with python code. Then we should distribute the output both on the web site and with the release tarball.

Unfortunately this requires fixing a bug in lore in its man page processor (ticket to be linked here soon).

Change History (19)

comment:1 Changed 7 years ago by therve

  • Cc therve added

What's the problem with lore exactly? Is it related to #1256?

comment:2 Changed 6 years ago by radix

This ticket isn't actually blocked on that other issue. It can be done independently.

I think therve is investigating the other issue now which will hopefully result in another ticket.

comment:3 Changed 6 years ago by therve

  • author set to therve
  • Branch set to branches/man-builder-2940

(In [22423]) Branching to 'man-builder-2940'

comment:4 Changed 6 years ago by therve

(In [22424]) Basic implementation of ManBuilder.

Refs #2940

comment:5 Changed 6 years ago by therve

  • Owner changed from radix to therve

comment:6 Changed 6 years ago by therve

The lore issue is #3017.

comment:7 Changed 6 years ago by therve

  • Keywords review added
  • Owner changed from therve to radix
  • Priority changed from normal to highest

Alright, this deserves a first look to check if it's in the right direction.

comment:8 Changed 6 years ago by radix

  • Keywords review removed
  • Owner changed from radix to therve
  1. I don't think we need a deleteInput option. We don't delete man files after converting them to lore.
  2. The docstring of ManBuilder.build could be improved. The summary should probably be "Generate Lore input files from man files."

Looks good! Thanks for working on this.

comment:9 Changed 6 years ago by therve

(In [22580]) Process review comments.

Refs #2940

comment:10 Changed 6 years ago by therve

  • Keywords review added
  • Owner changed from therve to radix

Done!

comment:11 Changed 6 years ago by radix

  • Keywords review removed
  • Owner changed from radix to therve

Please fix the >80 column lines in test_release.py. After that you can merge. Thanks!

comment:12 Changed 6 years ago by therve

(In [22583]) Fit into 80 columns.

Refs #2940

comment:13 Changed 6 years ago by therve

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

(In [22584]) Merge man-builder-2940

Author: therve
Reviewer: radix
Fixes #2940

Add a tested object to generate Lore files from man pages.

comment:14 Changed 6 years ago by therve

(In [22585]) Revert r22584: windows slaves failures.

Refs #2940

comment:15 Changed 6 years ago by therve

  • Resolution fixed deleted
  • Status changed from closed to reopened
[FAIL]: twisted.python.test.test_release.ManBuilderTestCase.test_build

Traceback (most recent call last):
  File "c:\twistedbuildbot24\WXP32-full2.5-scmikes-select\Twisted\twisted\python\test\test_release.py", line 535, in test_build
    self.assertEquals(output, "<html><head>\n<title>MANHOLE.1</title>"
twisted.trial.unittest.FailTest: not equal:
a = '<html><head>\r\n<title>MANHOLE.1</title></head>\r\n<body>\r\n\r\n<h1>MANHOLE.1</h1>\r\n\r\n<h2>NAME</h2>\r\n\r\n<p>manhole - Connect to a Twisted Manhole service\r\n</p>\r\n\r\n<h2>SYNOPSIS</h2>\r\n\r\n<p><strong>manhole</strong> </p>\r\n\r\n<h2>DESCRIPTION</h2>\r\n\r\n<p>manhole is a GTK interface to Twisted Manhole services. You can execute python\r\ncode as if at an interactive Python console inside a running Twisted process\r\nwith this.</p>\r\n\r\n</body>\r\n</html>\r\n'
b = '<html><head>\n<title>MANHOLE.1</title></head>\n<body>\n\n<h1>MANHOLE.1</h1>\n\n<h2>NAME</h2>\n\n<p>manhole - Connect to a Twisted Manhole service\n</p>\n\n<h2>SYNOPSIS</h2>\n\n<p><strong>manhole</strong> </p>\n\n<h2>DESCRIPTION</h2>\n\n<p>manhole is a GTK interface to Twisted Manhole services. You can execute python\ncode as if at an interactive Python console inside a running Twisted process\nwith this.</p>\n\n</body>\n</html>\n'

comment:16 Changed 6 years ago by therve

  • Keywords review added
  • Owner changed from therve to radix
  • Status changed from reopened to new

Just in case of.

comment:17 Changed 6 years ago by radix

  • Keywords review removed
  • Owner changed from radix to therve

+1

comment:18 Changed 6 years ago by therve

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

(In [22591]) Merge man-builder-2940

Author: therve
Reviewer: radix
Fixes #2940

Add a tested object to generate Lore files from man pages.

comment:19 Changed 3 years ago by <automation>

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