#10200: Catch Sphinx WARNING or ERROR
-------------------------------+--------------------------------------------
   Reporter:  jdemeyer         |       Owner:  GeorgSWeber               
       Type:  defect           |      Status:  needs_review              
   Priority:  major            |   Milestone:  sage-4.6.1                
  Component:  build            |    Keywords:  sphinx build documentation
     Author:  Jeroen Demeyer   |    Upstream:  N/A                       
   Reviewer:  Minh Van Nguyen  |      Merged:                            
Work_issues:                   |  
-------------------------------+--------------------------------------------
Changes (by mvngu):

  * reviewer:  => Minh Van Nguyen


Old description:

> When Sphinx gives a warning or error but continues, the user will usually
> never notice.  I propose that {{{doc/common/builder.py}}} should look for
> these errors and warnings and abort if a problem is found.

New description:

 When Sphinx gives a warning or error but continues, the user will usually
 never notice.  I propose that {{{doc/common/builder.py}}} should look for
 these errors and warnings and abort if a problem is found.

 '''Apply:'''

  1. [attachment:10200_docbuilder.patch]
  1. [attachment:trac-10200_reviewer.patch]

--

Comment:

 I'm mostly OK with jdemeyer's patch [attachment:10200_docbuilder.patch].
 But I also made some changes as follows:

  * Don't use the backslash character "\" for line continuation. Line
 continuation is already implied by the opening parenthesis.

  * Fix typos introduced by the patch [attachment:10200_docbuilder.patch].

  * Use
  {{{
 #!python
 <name> is not None
  }}}
  instead of
  {{{
 #!python
 not <name> is None
  }}}

  * Use symbolic names of exit code as documented at
 http://docs.python.org/library/errno.html, rather than hard-code the
 actual numeric values.

 See the ticket description for instructions on which patches to apply. If
 my patch gets a positive review, then the whole ticket gets a positive
 review.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10200#comment:7>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en.

Reply via email to