Improve lore2sphinx buildbot results for pb core howtos

[exarkun]

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

[exarkun]

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

[exarkun]

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

refs #4568 refs #4863

[jonathanj]

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

[jonathanj]

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

[jonathanj]

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.

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

[jonathanj]

Sphinx output  here.

[thijs]

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.

[jesstess]

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

[jonathanj]

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

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

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.

[khorn]

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!

[jonathanj]

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