Skip to content

Commit

Permalink
Merge remote-tracking branch 'matplotlib/v2.1.0-doc' into v2.1.x
Browse files Browse the repository at this point in the history
  • Loading branch information
tacaswell committed Oct 8, 2017
2 parents 132200d + 9173c86 commit 778ff3c
Showing 7 changed files with 238 additions and 346 deletions.
22 changes: 10 additions & 12 deletions INSTALL.rst
Original file line number Diff line number Diff line change
@@ -22,8 +22,8 @@ Installing an official release
Matplotlib and most of its dependencies are all available as wheel
packages for macOS, Windows and Linux distributions::

python -m pip install -U pip
python -m pip install -U matplotlib
python -mpip install -U pip
python -mpip install -U matplotlib

.. note::

@@ -150,16 +150,14 @@ Python, NumPy, libpng and FreeType), you can build Matplotlib.
::

cd matplotlib
python setup.py build
python setup.py install
python -mpip install .

We provide a `setup.cfg
<https://raw.githubusercontent.com/matplotlib/matplotlib/master/setup.cfg.template>`_
file that goes with :file:`setup.py` which you can use to customize
the build process. For example, which default backend to use, whether
some of the optional libraries that Matplotlib ships with are
installed, and so on. This file will be particularly useful to those
packaging Matplotlib.
We provide a setup.cfg_ file which you can use to customize the build
process. For example, which default backend to use, whether some of the
optional libraries that Matplotlib ships with are installed, and so on. This
file will be particularly useful to those packaging Matplotlib.

.. _setup.cfg: https://raw.githubusercontent.com/matplotlib/matplotlib/master/setup.cfg.template

If you have installed prerequisites to nonstandard places and need to
inform Matplotlib where they are, edit ``setupext.py`` and add the base
@@ -282,7 +280,7 @@ If you are using MacPorts, execute the following instead::
After installing the above requirements, install Matplotlib from source by
executing::

python setup.py install
python -mpip install .

Note that your environment is somewhat important. Some conda users have
found that, to run the tests, their PYTHONPATH must include
1 change: 1 addition & 0 deletions doc/_templates/citing.html
Original file line number Diff line number Diff line change
@@ -29,6 +29,7 @@ <h1>Citing Matplotlib</h1>

<h2>DOIs</h2>
<dl>
<dt>v2.1.0</dt><dd><a href="https://doi.org/10.5281/zenodo.1004650"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.1004650.svg" alt="DOI"></a></dd>
<dt>v2.0.2</dt><dd><a href="https://doi.org/10.5281/zenodo.573577"><img src="https://zenodo.org/badge/doi/10.5281/zenodo.573577.svg" alt="10.5281/zenodo.573577.svg"></a></dd>
<dt>v2.0.1</dt><dd><a href="https://doi.org/10.5281/zenodo.570311"><img src="https://zenodo.org/badge/doi/10.5281/zenodo.570311.svg" alt="10.5281/zenodo.570311.svg"></a></dd>
<dt>v2.0.0</dt><dd><a href="https://doi.org/10.5281/zenodo.248351"><img src="https://zenodo.org/badge/doi/10.5281/zenodo.248351.svg" alt="10.5281/zenodo.248351.svg"></a></dd>
20 changes: 9 additions & 11 deletions doc/devel/contributing.rst
Original file line number Diff line number Diff line change
@@ -90,33 +90,32 @@ the env ``MPLLOCALFREETYPE`` as::

export MPLLOCALFREETYPE=1

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

[test]
local_freetype = True


To install Matplotlib (and compile the c-extensions) run the following
command from the top-level directory ::

pip install -v -e ./
python -mpip install -ve .

This installs Matplotlib in 'editable/develop mode', i.e., builds
everything and places the correct link entries in the install
directory so that python will be able to import Matplotlib from the
source directory. Thus, any changes to the ``*.py`` files will be
reflected the next time you import the library. If you change the
c-extension source (which might happen if you change branches) you
will need to run::
C-extension source (which might happen if you change branches) you
will need to run ::

python setup.py build

or re-run ``pip install -v -e ./``.

or re-run ``python -mpip install -ve .``.

Alternatively, if you do ::

pip install -v ./
python -mpip 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.
@@ -132,7 +131,6 @@ environment is set up properly::

python tests.py


.. _pytest: http://doc.pytest.org/en/latest/
.. _pep8: https://pep8.readthedocs.io/en/latest/
.. _mock: https://docs.python.org/dev/library/unittest.mock.html
@@ -254,12 +252,12 @@ tools:
* Code with a good unittest coverage (at least 70%, better 100%), check
with::

pip install coverage
python -mpip install coverage
python tests.py --with-coverage

* No pyflakes warnings, check with::

pip install pyflakes
python -mpip install pyflakes
pyflakes path/to/module.py

.. note::
Loading

0 comments on commit 778ff3c

Please sign in to comment.