Ticket #6419 (closed defect: fixed)

Opened 14 months ago

Last modified 14 months ago

[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 Author(s): John Palmieri
Report Upstream: Reviewer(s): David Loeffler
Merged in: sage-4.1.rc0 Work issues:

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

misc_ref_6419.patch Download (1.2 KB) - added by jhpalmieri 14 months ago.

Change History

Changed 14 months ago by jhpalmieri

Changed 14 months ago by davidloeffler

  • reviewer 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

Changed 14 months ago by rlm

  • status changed from new to closed
  • resolution set to fixed
  • merged set to sage-4.1.rc0
Note: See TracTickets for help on using tickets.