Skip to content

Api doc backport no imag build #7779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 13, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ install:
cp .travis/setup.cfg .
fi;

- python setup.py install
- pip install -ve ./
- |

script:
Expand Down
14 changes: 14 additions & 0 deletions doc/api/api_changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 no longer includes test images
----------------------------------------------

To reduce the size of wheels and source installs, the tests and
baseline images are no longer included by default.

To restore installing the tests and images, use a `setup.cfg` with ::

[packages]
tests = True
toolkit_tests = True

in the source directory at build/install time.

Changes in 1.5.3
================

Expand Down
10 changes: 8 additions & 2 deletions doc/devel/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ the env ``MPLLOCALFREETYPE`` as::

export MPLLOCALFREETYPE=1

or copy :file:`setup.cfg.template` to :file:`setup.cfg` and edit to contain ::
or copy :file:`setup.cfg.template` to :file:`setup.cfg` and edit it to contain ::

[test]
local_freetype = True
Expand Down Expand Up @@ -80,9 +80,15 @@ Alternatively, if you do ::

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.
Additionally you will need to copy :file:`setup.cfg.template` to
:file:`setup.cfg` and edit it to contain ::

[test]
local_freetype = True
tests = True

You can then run the tests to check your work environment is set up properly::
In either case you can then run the tests to check your work
environment is set up properly::

python tests.py

Expand Down
1 change: 1 addition & 0 deletions doc/devel/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ matplotlib source directory::

[test]
local_freetype = True
tests = True

or by setting the ``MPLLOCALFREETYPE`` environmental variable to any true
value.
Expand Down
16 changes: 8 additions & 8 deletions setup.cfg.template
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Rename this file to setup.cfg to modify matplotlib's
# Rename this file to setup.cfg to modify Matplotlib's
# build options.

[egg_info]
Expand All @@ -9,7 +9,7 @@
#basedirlist = /usr

[test]
# If you plan to develop matplotlib and run or add to the test suite,
# If you plan to develop Matplotlib and run or add to the test suite,
# set this to True. It will download and build a specific version of
# FreeType, and then use that to build the ft2font extension. This
# ensures that test images are exactly reproducible.
Expand All @@ -21,11 +21,11 @@
#suppress = False

[packages]
# There are a number of subpackages of matplotlib that are considered
# optional. They are all installed by default, but they may be turned
# off here.
# There are a number of subpackages of Matplotlib that are considered
# optional. All except tests are installed by default, but that can
# be changed here.
#
#tests = True
#tests = False
#sample_data = True
#toolkits = True
# Tests for the toolkits are only automatically installed
Expand All @@ -36,10 +36,10 @@
# Matplotlib supports multiple GUI toolkits, including
# GTK, MacOSX, Qt4, Qt5, Tk, and WX. Support for many of
# these toolkits requires AGG, the Anti-Grain Geometry library,
# which is provided by matplotlib and built by default.
# which is provided by Matplotlib and built by default.
#
# Some backends are written in pure Python, and others require
# extension code to be compiled. By default, matplotlib checks for
# extension code to be compiled. By default, Matplotlib checks for
# these GUI toolkits during installation and, if present, compiles the
# required extensions to support the toolkit.
#
Expand Down
4 changes: 3 additions & 1 deletion setupext.py
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,7 @@ class OptionalPackage(SetupPackage):
optional = True
force = False
config_category = "packages"
default_config = "auto"

@classmethod
def get_config(cls):
Expand All @@ -541,7 +542,7 @@ def get_config(cls):
insensitively defined as 1, true, yes, on for True) or opted-out (case
insensitively defined as 0, false, no, off for False).
"""
conf = "auto"
conf = cls.default_config
if config is not None and config.has_option(cls.config_category, cls.name):
try:
conf = config.getboolean(cls.config_category, cls.name)
Expand Down Expand Up @@ -712,6 +713,7 @@ def get_namespace_packages(self):
class Tests(OptionalPackage):
name = "tests"
nose_min_version = '0.11.1'
default_config = False

def check(self):
super(Tests, self).check()
Expand Down