Api doc backport no imag build #7779

Merged
merged 4 commits into from Jan 13, 2017

Projects

None yet

4 participants

@tacaswell
Member

backport of #7757 + docs

dopplershift and others added some commits Jan 7, 2017
@dopplershift @tacaswell dopplershift Merge pull request #7757 from StephanErb/packaging_size
By default, don't include tests in binary distributions.
e83e108
@tacaswell tacaswell DOC: API notes for not installing tests/baseline images by default
Update to include details about how to re-enable.
e2e7235
doc/api/api_changes.rst
@@ -201,6 +201,20 @@ replaced by ``nipy_spectral`` and ``nipy_spectral_r`` since matplotlib
raised a warning. As of matplotlib 2.0.0, using the old names raises a
deprecation warning. In the future, using the old names will raise an error.
+Default install does not include test images
@QuLogic
QuLogic Jan 10, 2017 Member

does not include -> no longer includes

doc/api/api_changes.rst
+To reduce the default size of wheels and source installs, the tests
+and baseline images are no longer included by default.
+
+To restore installing the tests and images have a `setup.cfg` with ::
@QuLogic
QuLogic Jan 10, 2017 Member

images have -> images, use
(or add)

doc/devel/contributing.rst
@@ -79,10 +79,15 @@ Alternatively, if you do ::
pip install -v ./
all of the files will be copied to the installation directory however,
-you will have to rerun this command every time the source is changed.
+you will have to rerun this command every time the source is changed. Additionally you will
+need to copy :file:`setup.cfg.template` to :file:`setup.cfg` and edit to contain ::
@QuLogic
QuLogic Jan 10, 2017 Member

edit to -> edit it to

@tacaswell
Member

Apparently we have moved to using develop on the master branch, but not in 2.x....

@NelleV
NelleV approved these changes Jan 13, 2017 View changes

Apart from the minor comments (which IMO are minor enough that they can be ignored), this looks good.
👍

doc/api/api_changes.rst
+Default install does not include test images
+--------------------------------------------
+
+To reduce the default size of wheels and source installs, the tests
@NelleV
NelleV Jan 13, 2017 Contributor

Isn't "default" an extra word here?

setup.cfg.template
@@ -22,10 +22,10 @@
[packages]
# There are a number of subpackages of matplotlib that are considered
@NelleV
NelleV Jan 13, 2017 Contributor

matplotlib -> Matplotlib
(trying to catch them as they come…)

@NelleV NelleV changed the title from Api doc backport no imag build to [MRG+1] Api doc backport no imag build Jan 13, 2017
@tacaswell
Member

Took 3 tries, but I think I got all of them.

@NelleV
NelleV approved these changes Jan 13, 2017 View changes
@NelleV NelleV merged commit be4b213 into matplotlib:v2.x Jan 13, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@NelleV
Contributor
NelleV commented Jan 13, 2017

Thanks!

@QuLogic QuLogic changed the title from [MRG+1] Api doc backport no imag build to Api doc backport no imag build Jan 13, 2017
@tacaswell tacaswell deleted the tacaswell:API_DOC_backport_no_imag_build branch Jan 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment