DOC: API notes for not installing tests/baseline images by default

tacaswell · tacaswell · commit e2e7235f6701 · 2017-01-10T00:29:31.000-05:00
Update to include details about how to re-enable.
diff --git a/doc/api/api_changes.rst b/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
+--------------------------------------------
+
+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 ::
+
+   [packages]
+   tests = True
+   toolkit_tests = True
+
+in the source directory at build/install time.
+
 Changes in 1.5.3
 ================
 
diff --git a/doc/devel/contributing.rst b/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 ::
 
+  [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
 
diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst
@@ -45,6 +45,7 @@ matplotlib source directory::
 
   [test]
   local_freetype = True
+  tests = True
 
 or by setting the ``MPLLOCALFREETYPE`` environmental variable to any true
 value.
