Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 293525 - Please add 'doc' useflag to dev-python/numpy and sci-libs/scipy
Summary: Please add 'doc' useflag to dev-python/numpy and sci-libs/scipy
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: High minor (vote)
Assignee: Python Gentoo Team
URL: http://docs.scipy.org/doc/
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-11-17 18:37 UTC by Denilson Sá Maia
Modified: 2009-11-20 21:02 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Denilson Sá Maia 2009-11-17 18:37:45 UTC
Please add a 'doc' useflag to the following packages:
 dev-python/numpy
 sci-libs/scipy

This useflag should (conditionally) download and install numpy/scipy documentation, available as .pdf and zipped HTML. See:
http://docs.scipy.org/doc/

My suggestion is to add something like this to the SRC_URI:
doc? (
 http://docs.scipy.org/doc/numpy-1.3.x/numpy-html.zip -> numpy-1.3-html.zip
 http://docs.scipy.org/doc/numpy-1.3.x/numpy-ref.pdf -> numpy-1.3-ref.pdf
 http://docs.scipy.org/doc/numpy-1.3.x/numpy-user.pdf -> numpy-1.3-user.pdf
)
doc? (
 http://docs.scipy.org/doc/scipy-0.7.x/scipy-html.zip -> scipy-0.7-html.zip
 http://docs.scipy.org/doc/scipy-0.7.x/scipy-ref.pdf -> scipy-0.7-ref.pdf
)
And then install these files (unzipping them) to the documentation directory.

Improvements:
* use ${PN} at the URL.
* use ${MY_PV} instead of hardcoded 1.3 and 0.7, like this:
 http://docs.scipy.org/doc/${PN}-${MY_PV}.x/${PN}-ref.pdf -> ${PN}-${MY_PV}-ref.pdf


Motivation:
Many times I need the documentation while I'm offline. (yes, sometimes people need to work offline)
Comment 1 Sébastien Fabbro (RETIRED) gentoo-dev 2009-11-18 06:05:01 UTC
This sounds reasonnable. Do you know whether you can build this doc from the numpy/scipy source tar balls with sphinx in which case we should rely on that instead of the arrow hack?

Thanks.


Comment 2 Denilson Sá Maia 2009-11-19 03:26:02 UTC
(In reply to comment #1)
> This sounds reasonnable. Do you know whether you can build this doc from the
> numpy/scipy source tar balls with sphinx in which case we should rely on that
> instead of the arrow hack?

Not sure. I've noticed that there is a "doc" dir inside numpy and scipy tarballs. It even has a Makefile. However, I couldn't build any documentation from it (but haven't tried too much, I just quickly messed with it for a couple of minutes).

Even if building from the tarball is possible, we should check if it builds both the reference and the userguide (in case of numpy).

By the way, that thing is not really a hack. That arrow is a documented feature of EAPI=2.
Comment 3 Sébastien Fabbro (RETIRED) gentoo-dev 2009-11-20 21:02:41 UTC
doc flag now available for both numpy and scipy
thanks