Opened 6 years ago

Closed 6 years ago

#4863 enhancement closed fixed (fixed)

Improve lore2sphinx buildbot results for pb core howtos

Reported by: Jean-Paul Calderone Owned by: Jonathan Jacobs
Priority: normal Milestone: Lore to Sphinx
Component: core Keywords: documentation
Cc: Thijs Triemstra, jesstess Branch: branches/pb-sphinx-4863
branch-diff, diff-cov, branch-cov, buildbot
Author: screwtape, jdb

Description

like #4566, except for the seven pb howtos in projects/core/howto

Change History (18)

comment:1 Changed 6 years ago by Jean-Paul Calderone

Author: exarkun
Branch: branches/pb-sphinx-4863

(In [30658]) Branching to 'pb-sphinx-4863'

comment:2 Changed 6 years ago by Jean-Paul Calderone

(In [30659]) Merge the pb parts of the impossibly huge #4568 branch

refs #4568 refs #4863

comment:3 Changed 6 years ago by Jean-Paul Calderone

Author: exarkunscrewtape, jdb
Keywords: documentation review added; documentations removed

comment:4 Changed 6 years ago by Jonathan Jacobs

(In [30697]) Fix footnote linking, refs #4863.

comment:5 Changed 6 years ago by Jonathan Jacobs

(In [30698]) Fix unexpected new paragraphs, refs #4863.

comment:6 Changed 6 years ago by Jonathan Jacobs

Keywords: review removed

I fixed a few minor issues:

  • Broken footnote linking due to unusual markup style in the footnote.
  • Unexpected paragraph breaks around <code> items, particularly in footnotes.

This branch looks good to merge.

comment:7 Changed 6 years ago by <automation>

comment:8 Changed 6 years ago by Jonathan Jacobs

Keywords: review added

I'm putting this back up for review because I'd like someone with experience with previous lore2sphinx tickets to give it a once over.

comment:9 Changed 6 years ago by Jonathan Jacobs

Sphinx output here.

comment:10 in reply to:  8 Changed 6 years ago by Thijs Triemstra

Cc: Thijs Triemstra added

Replying to jonathanj:

I'm putting this back up for review because I'd like someone with experience with previous lore2sphinx tickets to give it a once over.

What would be the best place to review the lore2sphinx tickets, can't seem to find the wiki page.

comment:11 Changed 6 years ago by khorn

Milestone: Lore to Sphinx

comment:12 Changed 6 years ago by jesstess

Owner: set to jesstess

comment:13 Changed 6 years ago by jesstess

Cc: jesstess added
Keywords: review removed
Owner: changed from jesstess to Jonathan Jacobs

Thanks for working on the chunks of this enormous changeset. Some feedback:

There are some issues that exist everywhere in the docs. Maybe they need their own meta-tickets:

  • <code> tags are forcing a space after the enclosed text, even if you don't want it.
  • Similarly, the <q> tags are forcing a space afterwards, even if you don't want it.
  • We've lost the hyperlinks on the listings.

Ticket-specific feedback:

  • pb-cred: the twisted.spread.flavors.Viewable hyperlink is broken (it is on the live documentation too).
  • pb-usage:
    • Needs a space after the 'the': The “client” can give a reference to the”server”
    • Needs a space after the 'and': fuzzes the distinction between “client” and”server"
    • There's a broken hyperlink to twisted.spread.pb.InsecureJelly

comment:14 Changed 6 years ago by Jonathan Jacobs

(In [31005]) Fix broken API hyperlinks and some whitespace issues, refs #4863.

comment:15 in reply to:  13 ; Changed 6 years ago by Jonathan Jacobs

Keywords: review added
Owner: changed from Jonathan Jacobs to jesstess

Replying to jesstess:

There are some issues that exist everywhere in the docs. Maybe they need their own meta-tickets:

  • <code> tags are forcing a space after the enclosed text, even if you don't want it.
  • Similarly, the <q> tags are forcing a space afterwards, even if you don't want it.
  • We've lost the hyperlinks on the listings.

I've mentioned some of these in passing before; since they're really issues with the lore2sphinx tool (as far as I can tell) I think they belong in another ticket.

Ticket-specific feedback:

  • pb-cred: the twisted.spread.flavors.Viewable hyperlink is broken (it is on the live documentation too).
  • pb-usage:
    • Needs a space after the 'the': The “client” can give a reference to the”server”
    • Needs a space after the 'and': fuzzes the distinction between “client” and”server"
    • There's a broken hyperlink to twisted.spread.pb.InsecureJelly

Fixed.

comment:16 Changed 6 years ago by khorn

Keywords: review removed
Owner: changed from jesstess to khorn

comment:17 in reply to:  15 Changed 6 years ago by khorn

Owner: changed from khorn to Jonathan Jacobs

Replying to jonathanj:

Replying to jesstess:

There are some issues that exist everywhere in the docs. Maybe they need their own meta-tickets:

  • <code> tags are forcing a space after the enclosed text, even if you don't want it.
  • Similarly, the <q> tags are forcing a space afterwards, even if you don't want it.
  • We've lost the hyperlinks on the listings.

I've mentioned some of these in passing before; since they're really issues with the lore2sphinx tool (as far as I can tell) I think they belong in another ticket.

Yes, these are lore2sphinx issues. It is impractical to fix them automatically. These will be handled post-conversion.

Ticket-specific feedback:

  • pb-cred: the twisted.spread.flavors.Viewable hyperlink is broken (it is on the live documentation too).
  • pb-usage:
    • Needs a space after the 'the': The “client” can give a reference to the”server”
    • Needs a space after the 'and': fuzzes the distinction between “client” and”server"
    • There's a broken hyperlink to twisted.spread.pb.InsecureJelly

Fixed.

Verified these have been fixed. Looks good to me.

Merge like the wind!

comment:18 Changed 6 years ago by Jonathan Jacobs

Resolution: fixed
Status: newclosed

(In [31014]) Merge branches/pb-sphinx-4863.

Author: jdb, screwtape, jonathanj Reviewer: khorn, jesstess Fixes: #4863

Clean up lore2sphinx conversion for PB core howto documentation.

Note: See TracTickets for help on using tickets.