Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#4566 enhancement closed fixed (fixed)

Improve lore2sphinx buildbot results for `projects/conch`

Reported by: khorn Owned by: Screwtape
Priority: normal Milestone: Lore to Sphinx
Component: core Keywords: documentation
Cc: Branch: branches/improve-lore2sphinx-output-for-projects-conch-4566
branch-diff, diff-cov, branch-cov, buildbot
Author: screwtape

Description

Make the lore2sphinx buildbot results for projects/conch look as good as possible by modifying the lore sources.

Things to look for:

  1. nested inline markup should be removed
  2. whitespace should be added or removed as needed to make ReST markup render properly
  3. anything else that you can improve by modifying the Lore sources

Note that you probably want to run lore2sphinx on a local copy for development purposes.

You can get lore2sphinx from: http://bitbucket.org/khorn/lore2sphinx

Attachments (1)

lore-conch-cleanups.diff (5.4 KB) - added by Screwtape 7 years ago.
A patch that cleans up the Sphinx rendering of the Conch docs.

Download all attachments as: .zip

Change History (14)

comment:1 Changed 7 years ago by Screwtape

Owner: changed from Glyph to Screwtape
Status: newassigned

Changed 7 years ago by Screwtape

Attachment: lore-conch-cleanups.diff added

A patch that cleans up the Sphinx rendering of the Conch docs.

comment:2 Changed 7 years ago by khorn

The lore2sphinx buildbot results can be found at:

http://buildbot.twistedmatrix.com/builds/sphinx-html-15615/

(or at different directories for different revisions...the containing directory is browseable)

comment:3 Changed 7 years ago by Screwtape

Keywords: documentation review added
Owner: Screwtape deleted
Status: assignednew

Changes in this patch:

  • Added trailing spaces to a few lines so that the element on the next line would be correctly rendered, not rendered as raw ReST markup.
  • Fixed some links to point to the correct places.
  • The link to telnet_echo.tac now shows its description.
  • Added descriptions for sshsimpleclient.py and sshsimpleserver.py.
  • Filenames and descriptions on the examples page are separated by hyphens, as they are in the Twisted Core examples page

comment:4 Changed 7 years ago by Screwtape

Oh, and things that aren't fixed: spaces between inline markup and end-of-sentence punctuation.

comment:5 Changed 7 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to Screwtape

Looks fine, although it's missing a news fragment. One thing I noticed while reviewing this, though, is that code listings no longer have line numbers. Could you file a ticket for that?

comment:6 Changed 7 years ago by Screwtape

One thing I noticed while reviewing this, though, is that code listings no longer have line numbers.

Filed as #4586.

comment:7 Changed 7 years ago by screwtape

Author: screwtape
Branch: branches/improve-lore2sphinx-output-for-projects-conch-4566

(In [29822]) Create branch improve-lore2sphinx-output-for-projects-conch-4566

comment:8 Changed 7 years ago by screwtape

(In [29823]) Apply lore-conch-cleanups.diff

refs #4566

comment:9 Changed 7 years ago by screwtape

(In [29824]) Address exarkun's code-review comments.

refs #4566

comment:10 Changed 7 years ago by Screwtape

Keywords: review added
Owner: Screwtape deleted

Sphinx output here.

comment:11 Changed 7 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to Screwtape

Looks good. Please merge.

comment:12 Changed 7 years ago by screwtape

Resolution: fixed
Status: newclosed

(In [29850]) Merge improve-lore2sphinx-output-for-projects-conch-4566: Tidy conch docs for lore2sphinx conversion.

Author: screwtape Reviewers: exarkun Fixes: #4566

  • Added trailing spaces to a few lines so that the element on the next line would be correctly rendered, not rendered as raw ReST markup.
  • Fixed some links to point to the correct places.
  • The link to telnet_echo.tac now shows its description.
  • Added descriptions for sshsimpleclient.py and sshsimpleserver.py.
  • Filenames and descriptions on the examples page are separated by hyphens, as they are in the Twisted Core examples page

comment:13 Changed 7 years ago by khorn

Milestone: Lore to Sphinx
Note: See TracTickets for help on using tickets.