Sphinx should raise warning in case of ill formated enumerated lists

[hivert]

In some cases, for example when an enumerated list is ill formated, in text mode ouput sphinx returns silently an empty string. It should at least raise some warning. See #8572 for an instance of the problem.
At this point, I don't know if it's a bug of sphinx or the way we call it.

Upstream: Completely fixed; Fix reported upstream

CC: @jhpalmieri @qed777

Component: documentation

Keywords: Sphinx, warning

Reviewer: Florent Hivert

Issue created by migration from https://trac.sagemath.org/ticket/8575

[hivert]

comment:2

There is a very good chance that this is a bug of sphinx. I asked it on
sphinx-dev. I'm waiting for their answer.

For the info, here is a ReST file that triggers the problem:

**************************
List Bug Triggering Module
**************************

    - list item 1 -- this item is correctly formated. So that there should be
      no problem with it..

    - list item 2 -- this item is ill formated. Sphinx should raise a warning
       when typesetting in in text mode.

Florent

[hivert]

comment:3

This is indeed a bug of sphinx (see this Sphinx-dev thread). Georg Brandl answered:

The behavior is clearly a bug, and I've now fixed it in changeset 93ae46825651
in the 0.6 branch. It will be part of the next bugfix release.

I'm not sure what to do now with this ticket... Should we back port the bugfix or wait for the next release ? Should this ticket be left open ?

Florent

[hivert]

Upstream: Fixed upstream, in a later stable release.

[sagetrac-mvngu]

comment:4

Replying to @hivert:

I'm not sure what to do now with this ticket... Should we back port the bugfix or wait for the next release ? Should this ticket be left open ?

I would think wait for the next release, as that is (maybe) much easier than backporting. If you can backport, then by all means do so. Until the issue is fixed by upgrading to the new release with the bug fixed, or backporting, this ticket would remain open.

[hivert]

Work Issues: Sphinx release 0.6.6

[hivert]

comment:5

Replying to @sagetrac-mvngu:

I would think wait for the next release, as that is (maybe) much easier than backporting. If you can backport, then by all means do so. Until the issue is fixed by upgrading to the new release with the bug fixed, or backporting, this ticket would remain open.

According to Georg Brandl, Sphinx should make a new bugfix release "soon"... So I'm in favor of waiting for it.

[hivert]

Reviewer: Florent Hivert

[hivert]

comment:6

This ticket should be closed since sage uses now sphinx 1.0.4

(WARNING/2) Bullet list ends without a blank line; unexpected unindent.

I set this to positive review.

[hivert]

Changed upstream from Fixed upstream, in a later stable release. to Completely fixed; Fix reported upstream

[jdemeyer]

Changed work issues from Sphinx release 0.6.6 to none