Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Doc updates #9291

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

Doc updates #9291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3b52f44
Update venv faq.
anntzer Sep 20, 2017
296befb
Update installation faq.
anntzer Sep 20, 2017
10f78c4
Update troubleshooting faq.
anntzer Sep 20, 2017
ca0114f
Fully switch from setup.py install to pip.
anntzer Sep 21, 2017
87960f8
DOC: tweak package manager istall wording
tacaswell Oct 7, 2017
3ae1336
DOC: tweak OSX install faq
tacaswell Oct 7, 2017
5562bf0
Tweak wording in install faq.
anntzer Oct 7, 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
22 changes: 10 additions & 12 deletions INSTALL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

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