#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:
- nested inline markup should be removed
- whitespace should be added or removed as needed to make ReST markup render properly
- 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)
Change History (14)
comment:1 Changed 7 years ago by
| Owner: | changed from Glyph to Screwtape |
|---|---|
| Status: | new → assigned |
Changed 7 years ago by
| Attachment: | lore-conch-cleanups.diff added |
|---|
comment:2 Changed 7 years ago by
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
| Keywords: | documentation review added |
|---|---|
| Owner: | Screwtape deleted |
| Status: | assigned → new |
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.tacnow shows its description. - Added descriptions for
sshsimpleclient.pyandsshsimpleserver.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
Oh, and things that aren't fixed: spaces between inline markup and end-of-sentence punctuation.
comment:5 Changed 7 years ago by
| 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
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
| Author: | → screwtape |
|---|---|
| Branch: | → branches/improve-lore2sphinx-output-for-projects-conch-4566 |
(In [29822]) Create branch improve-lore2sphinx-output-for-projects-conch-4566
comment:10 Changed 7 years ago by
| Keywords: | review added |
|---|---|
| Owner: | Screwtape deleted |
Sphinx output here.
comment:11 Changed 7 years ago by
| Keywords: | review removed |
|---|---|
| Owner: | set to Screwtape |
Looks good. Please merge.
comment:12 Changed 7 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
(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
| Milestone: | → Lore to Sphinx |
|---|
A patch that cleans up the Sphinx rendering of the Conch docs.