Opened 4 years ago

Closed 3 years ago

#4864 enhancement closed fixed (fixed)

Improve lore2sphinx buildbot results for `projects/core/howto/logging.xhtml`

Reported by: exarkun Owned by: lvh
Priority: normal Milestone: Lore to Sphinx
Component: core Keywords: documentation
Cc: Branch: branches/logging-sphinx-4864
(diff, github, buildbot, log)
Author: screwtape, jdb Launchpad Bug:

Description

like #4566, except for the logging howto

Change History (11)

comment:1 Changed 4 years ago by exarkun

  • Author set to exarkun
  • Branch set to branches/logging-sphinx-4864

(In [30660]) Branching to 'logging-sphinx-4864'

comment:2 Changed 4 years ago by exarkun

(In [30661]) Merge the logging parts of the impossibly huge #4568 branch

refs #4568
refs #4864

comment:3 Changed 4 years ago by exarkun

  • Author changed from exarkun to screwtape, jdb
  • Keywords review added

comment:4 Changed 4 years ago by tenth

  • Keywords review removed
  • Owner set to Screwtape

For the first change: If you're removing the link on "msg" because the link is broken, that's due to a bug in the API generation (see #1703) and it should be be possible to fix it, rather than removing the link altogether.

The second change, where you add an example that imports DailyLogFile: The example is fine, but it would be nice if DailyLogFile was explained before being used in example code. (Maybe move the new example down so that it's after the description of DailyLogFile under the "Log Files" heading, or vice-versa?)

Finally, there are several places where a space appears between the end of a markup tag and the ending punctuation (usually a period). For example:

"You can disable this by passing setStdout=False to startLogging ."

If this is intentional, great! Or if it's required by Sphinx, I guess we're stuck with it. But if it's by accident, maybe we need to handle those markup cases differently?

comment:5 Changed 3 years ago by khorn

  • Milestone set to Lore to Sphinx

comment:6 Changed 3 years ago by khorn

The space between the end of a markup tag and punctuation is an artifact of the lore2sphinx script which converts the lore sources. It can be fixed in the Sphinx sources, but doing it automatically and reliably is a total beast, so we just stick a space everywhere for now.

comment:7 Changed 3 years ago by khorn

(In [31054]) Fix broken api link to t.p.l.LogPublisher.msg

refs: #4864

comment:8 Changed 3 years ago by khorn

  • Keywords review added
  • Owner Screwtape deleted

send to review queue

comment:9 Changed 3 years ago by lvh

  • Owner set to lvh
  • Status changed from new to assigned

comment:10 Changed 3 years ago by lvh

  • Keywords review removed

Yeah pretty trivial fix. merging. Thanks!

comment:11 Changed 3 years ago by lvh

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

(In [31058]) Better lore2sphinx output for logging.xhtml

Author: khorn, Screwtape, jdb
Reviewer: tenth, lvh
Fixes: #4864

"Make Sphinx look gooder" -- JP

Note: See TracTickets for help on using tickets.