[NumPy-Tickets] [NumPy] #1772: autosummary output for classes broken

NumPy Trac numpy-tickets@scipy....
Sat Jun 25 14:02:37 CDT 2011


#1772: autosummary output for classes broken
----------------------------+-----------------------------------------------
  Reporter:  rgommers       |       Owner:  pv         
      Type:  defect         |      Status:  closed     
  Priority:  normal         |   Milestone:  Unscheduled
 Component:  Documentation  |     Version:  1.5.1      
Resolution:  fixed          |    Keywords:             
----------------------------+-----------------------------------------------
Changes (by pv):

  * status:  new => closed
  * resolution:  => fixed


Comment:

 It's a Sphinx bug. I have a fix here: https://bitbucket.org/pv/sphinx-work
 -- will send a pull request to Georg once I clean the queue up a bit.

 I applied the patches to the automatic doc builds, so now we get something
 more useful:
 http://docs.scipy.org/doc/numpy/reference/generated/numpy.chararray.html

 We don't want to remote the custom template. The point is that the
 `numpydoc` extension already generates the method/attribute lists, so we
 don't want duplicate lists there. However, we *do* want to trick the
 `autosummary` module to generate the stub pages for the listed items --
 that's why it says "HACK" there: the autosummary block is in reality
 inside a comment, but this tricks the simple parser. Ugly, but works...

-- 
Ticket URL: <http://projects.scipy.org/numpy/ticket/1772#comment:1>
NumPy <http://projects.scipy.org/numpy>
My example project


More information about the NumPy-Tickets mailing list