Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#10191 closed defect (duplicate)

Catch fatal Sphinx errors

Reported by: jdemeyer Owned by: GeorgSWeber
Priority: major Milestone: sage-duplicate/invalid/wontfix
Component: build Keywords: sphinx build docbuilder documentation
Cc: mvngu, leif Merged in:
Authors: Reviewers: Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by jdemeyer)

Ensure that the building of Sage aborts after a fatal Sphinx error. The build still continues after non-fatal errors or warnings.

The attached patch does this by raising a Python exception if Sphinx fails.

Obsoleted by #10200

Attachments (4)

10191_sphinx_error.patch (931 bytes) - added by jdemeyer 11 years ago.
Create a deliberate Sphinx error, for testing
10191_sphinx_warning.patch (939 bytes) - added by jdemeyer 11 years ago.
Create a deliberate Sphinx warning, for testing
10191_catch_sphinx_error.2.patch (917 bytes) - added by jdemeyer 11 years ago.
SAGELIB patch
10191_catch_sphinx_error.patch (968 bytes) - added by jdemeyer 11 years ago.
SAGELIB patch

Download all attachments as: .zip

Change History (21)

comment:1 Changed 11 years ago by jdemeyer

  • Status changed from new to needs_review

comment:2 Changed 11 years ago by jdemeyer

  • Description modified (diff)

Changed 11 years ago by jdemeyer

Create a deliberate Sphinx error, for testing

Changed 11 years ago by jdemeyer

Create a deliberate Sphinx warning, for testing

Changed 11 years ago by jdemeyer

SAGELIB patch

comment:3 Changed 11 years ago by jdemeyer

  • Description modified (diff)

comment:4 Changed 11 years ago by jdemeyer

  • Description modified (diff)

Changed 11 years ago by jdemeyer

SAGELIB patch

comment:5 Changed 11 years ago by jdemeyer

  • Description modified (diff)

comment:6 Changed 11 years ago by jdemeyer

  • Authors set to Jeroen Demeyer

comment:7 Changed 11 years ago by jdemeyer

  • Merged in set to sage-4.6.1.alpha0

comment:8 Changed 11 years ago by jdemeyer

  • Description modified (diff)
  • Summary changed from Catch Sphinx errors to Catch fatal Sphinx errors

comment:9 Changed 11 years ago by jdemeyer

  • Description modified (diff)

comment:10 follow-up: Changed 11 years ago by leif

  • Cc mvngu added
  • Keywords docbuilder documentation added

I guess you haven't been aware of #9426...

There are two (almost) identical patches to the Sage library, where the .2 is the older one.

comment:11 Changed 11 years ago by leif

P.S.: Does Sphinx now also raise an error because of "then ``None`` wil be returned."?

comment:12 in reply to: ↑ 10 ; follow-up: Changed 11 years ago by jdemeyer

Replying to leif:

I guess you haven't been aware of #9426...

True.

There are two (almost) identical patches to the Sage library, where the .2 is the older one.

The .2 was a mistake by me, apply 10191_catch_sphinx_error.patch like the description of the ticket says :-)

Replying to leif:

P.S.: Does Sphinx now also raise an error because of "then ``None`` wil be returned."?

I don't understand what you mean...

comment:13 in reply to: ↑ 12 ; follow-up: Changed 11 years ago by leif

Replying to jdemeyer:

Replying to leif:

P.S.: Does Sphinx now also raise an error because of "then ``None`` wil be returned."?

I don't understand what you mean...

I meant does it now do spell-checking as well. Your "Sphinx error example" was a bit ambiguous in that way.

comment:14 in reply to: ↑ 13 Changed 11 years ago by jdemeyer

Replying to leif:

I meant does it now do spell-checking as well. Your "Sphinx error example" was a bit ambiguous in that way.

Allright, see #10210.

comment:15 Changed 11 years ago by jdemeyer

  • Cc leif added

Any obstructions for this patch (10191_catch_sphinx_error.patch) to get positive review?

comment:16 Changed 11 years ago by jdemeyer

  • Authors Jeroen Demeyer deleted
  • Description modified (diff)
  • Merged in sage-4.6.1.alpha0 deleted
  • Resolution set to duplicate
  • Reviewers set to Jeroen Demeyer
  • Status changed from needs_review to closed

comment:17 Changed 11 years ago by mvngu

  • Milestone changed from sage-4.6.1 to sage-duplicate/invalid/wontfix
Note: See TracTickets for help on using tickets.