[NumPy-Tickets] [NumPy] #2245: Encode numpy version into and normalize documentation file names

[NumPy Trac]

#2245: Encode numpy version into and normalize documentation file names
---------------------------+------------------------------------------------
 Reporter:  neirbowj       |       Owner:  pv         
     Type:  enhancement    |      Status:  new        
 Priority:  normal         |   Milestone:  Unscheduled
Component:  Documentation  |     Version:  none       
 Keywords:  doc pdf        |  
---------------------------+------------------------------------------------
 '''Synopsis'''

 This is a usability enhancement request to modify the documentation
 release engineering procedure so that an off-line copy of the docs can be
 readily paired with its associated release by file name only.

 '''Current behavior'''

 [http://docs.scipy.org/doc/numpy-1.6.0/numpy-ref.pdf Numpy Reference Guide
 1.6][[BR]]
 [http://docs.scipy.org/doc/numpy-1.6.0/numpy-user.pdf Numpy User Guide
 1.6]

 [http://sourceforge.net/projects/numpy/files/NumPy/1.6.2/reference.pdf/download
 reference.pdf][[BR]]
 [http://sourceforge.net/projects/numpy/files/NumPy/1.6.2/userguide.pdf/download
 userguide.pdf][[BR]]

 '''Desired behavior'''

 [http://docs.scipy.org/doc/numpy-1.6.0/numpy-ref-1.6.0.pdf Numpy Reference
 Guide 1.6][[BR]]
 [http://docs.scipy.org/doc/numpy-1.6.0/numpy-user-1.6.0.pdf Numpy User
 Guide]

 [http://sourceforge.net/projects/numpy/files/NumPy/1.6.2/numpy-
 ref-1.6.2.pdf/download numpy-ref-1.6.2.pdf][[BR]]
 [http://sourceforge.net/projects/numpy/files/NumPy/1.6.2/numpy-
 user-1.6.2.pdf/download numpy-user-1.6.2.pdf]

 '''Rationale'''

 Without a version in the filename, it is necessary to open each file to
 answer the questions, "What documentation do I have?" and "Do I have the
 documentation for version X.Y.Z?"

 Case in point: The FreeBSD ports system checks for the existence of a
 cached copy of the distfiles before fetching them. It also verifies the
 digest of each cached or fetched file against one published by the port
 maintainer. The numpy pdfs have different digests but the same names for
 different versions, so the old copy is cached but fails verification. This
 requires user intervention to diagnose and resolve.

 Users beyond the FreeBSD community may benefit from this enhancement,
 which is why I am filing the request here instead of with FreeBSD.

-- 
Ticket URL: <http://projects.scipy.org/numpy/ticket/2245>
NumPy <http://projects.scipy.org/numpy>
My example project