Opened 12 years ago

Closed 12 years ago

#6419 closed defect (fixed)

[with patch, positive review] fix ref manual warnings for sage.misc.misc

Reported by: jhpalmieri Owned by: jhpalmieri
Priority: minor Milestone: sage-4.1
Component: documentation Keywords:
Cc: mhansen Merged in: sage-4.1.rc0
Authors: John Palmieri Reviewers: David Loeffler
Report Upstream: Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

This patch fixes the warnings

WARNING: /Applications/sage_builds/sage-4.1.alpha1/devel/sage-new/doc/en/reference/sage/misc/misc.rst:6: 
(WARNING/2) autodoc can't import/find class 'sage.misc.misc.MainClass.NestedClass', it reported error: 
"No module named MainClass", please check your spelling and sys.path
WARNING: /Applications/sage_builds/sage-4.1.alpha1/devel/sage-new/doc/en/reference/sage/misc/misc.rst:6: 
(WARNING/2) autodoc can't import/find class 'sage.misc.misc.MainClass.NestedClass.NestedSubClass', it 
reported error: "No module named MainClass.NestedClass", please 
check your spelling and sys.path

produced by Sphinx when building the html version of the reference manual, by omitting these classes from the documentation.

Attachments (1)

misc_ref_6419.patch (1.2 KB) - added by jhpalmieri 12 years ago.

Download all attachments as: .zip

Change History (3)

Changed 12 years ago by jhpalmieri

comment:1 Changed 12 years ago by davidloeffler

  • Reviewers set to David Loeffler
  • Summary changed from [with patch, needs review] fix ref manual warnings for sage.misc.misc to [with patch, positive review] fix ref manual warnings for sage.misc.misc

Looks good to me. It's a pity that Sphinx can't handle this a bit better, but anyone who needs to know about nested classes is going to be a pretty hardcore Sage hacker who is more than capable of just reading the docs themselves. Positive review.

David

comment:2 Changed 12 years ago by rlm

  • Merged in set to sage-4.1.rc0
  • Resolution set to fixed
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.