8000 DOC: fill out dev docs by mattip · Pull Request #9378 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: fill out dev docs #9378

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 6 commits into from
Oct 18, 2017
Merged

DOC: fill out dev docs #9378

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
60e9feb
fill out dev docs
mattip Oct 12, 2017
1bf4450
document alternative to automatic download
mattip Oct 12, 2017
753bed2
fixes from reviewers, failed CI, reshuffle FreeType section
mattip Oct 16, 2017
df0cdd0
remove unneeded link
mattip Oct 16, 2017
680f178
matplotlib to Matplotlib
mattip Oct 17, 2017
c856d0c
add ..ing
mattip Oct 17, 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
matplotlib to Matplotlib
  • Loading branch information
@mattip
mattip committed Oct 17, 2017
commit 680f1786394908a8f4f5b2caed355cadb30ed61f
8 changes: 4 additions & 4 deletions doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,15 @@ you can use ``git@`` instead of ``https://``, which works through the ssh proto
and might be easier to use if you are using 2-factor authentication.


Building matplotlib for image comparison tests
Building Matplotlib for image comparison tests
----------------------------------------------

Matplotlib's test suite makes heavy use of image comparison tests,
meaning the result of a plot is compared against a known good result.
Unfortunately, different versions of FreeType produce differently
formed characters, causing these image comparisons to fail. To make
them reproducible, matplotlib can be built with a special local copy
of FreeType. This is recommended for all matplotlib developers.
them reproducible, Matplotlib can be built with a special local copy
of FreeType. This is recommended for all Matplotlib developers.

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

Expand All @@ -106,7 +106,7 @@ or set the ``MPLLOCALFREETYPE`` environmental variable to any true
value.


Install matplotlib in developer mode
Install Matplotlib in developer mode
------------------------------------

To install Matplotlib (and compile the c-extensions) run the following
Expand Down
7 changes: 3 additions & 4 deletions doc/devel/testing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,7 @@ Writing an image based test is only slightly more difficult than a
simple test. The main consideration is that you must specify the
"baseline", or expected, images in the
:func:`~matplotlib.testing.decorators.image_comparison` decorator. For
example, this test generates a single image and automatically tests
it::
example, this test generates a single image and automatically tests it::

import numpy as np
import matplotlib
Expand Down Expand Up @@ -246,13 +245,13 @@ repository <https://github.com/matplotlib/matplotlib/>`_ -- for
example, see `its Travis page
<https://travis-ci.org/matplotlib/matplotlib>`_.

If you want to enable Travis CI for your personal matplotlib GitHub
If you want to enable Travis CI for your personal Matplotlib GitHub
repo, simply enable the repo to use Travis CI in either the Travis CI
UI or the GitHub UI (Admin | Service Hooks). For details, see `the
Travis CI Getting Started page
<https://docs.travis-ci.com/user/getting-started/>`_. This
generally isn't necessary, since any pull request submitted against
the main matplotlib repository will be tested.
the main Matplotlib repository will be tested.

Once this is configured, you can see the Travis CI results at
https://travis-ci.org/your_GitHub_user_name/matplotlib -- here's `an
Expand Down
0