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.

Sign up for GitHub

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

Api doc backport no imag build #7779

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e83e108
Merge pull request #7757 from StephanErb/packaging_size
dopplershift Jan 7, 2017
e2e7235
DOC: API notes for not installing tests/baseline images by default
tacaswell Jan 10, 2017
5ca204d
TST: source install so we find test images
tacaswell Jan 12, 2017
ca6bb75
DOC: minor doc tweaks
tacaswell Jan 13, 2017
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
Prev Previous commit
Next Next commit
DOC: API notes for not installing tests/baseline images by default 
Update to include details about how to re-enable.
  • Loading branch information
@tacaswell
tacaswell committed Jan 10, 2017
commit e2e7235f6701529ea5d8f4528c8b179df6842d98
14 changes: 14 additions & 0 deletions doc/api/api_changes.rst
View file
Open in desktop
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 does not include test images
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does not include -> no longer includes

--------------------------------------------

To reduce the default size of wheels and source installs, the tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't "default" an extra word here?

and baseline images are no longer included by default.

To restore installing the tests and images have a `setup.cfg` with ::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

images have -> images, use
(or add)


[packages]
tests = True
toolkit_tests = True

in the source directory at build/install time.

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

Expand Down
9 changes: 7 additions & 2 deletions doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

edit to -> edit it to


[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
View file
Open in desktop
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