8000 FIX: Dev installation instructions documentation issue by roopchansinghv · Pull Request #8888 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

FIX: Dev installation instructions documentation issue #8888

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 1 commit into from
Jul 16, 2017
Merged

FIX: Dev installation instructions documentation issue #8888

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 20 additions & 9 deletions doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,28 @@ Thank you for your help in keeping bug reports complete, targeted and descriptiv
Retrieving and installing the latest version of the code
=================================================== 8000 =====

When working on the Matplotlib source, setting up a `virtual
environment
<http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_ or a
`conda environment <http://conda.pydata.org/docs/using/envs.html>`_ is
recommended.
When developing Matplotlib, sources must be downloaded, built, and installed into
a local environment on your machine.

Follow the instructions detailed :ref:`here <install_from_source>` to set up your
environment to build Matplotlib from source.

.. warning::

If you already have a version of Matplotlib installed, use an
virtual environment or uninstall using the same method you used
to install it. Installing multiple versions of Matplotlib via different
methods into the same environment may not always work as expected.
When working on Matplotlib sources, having multiple versions installed by
different methods into the same environment may not always work as expected.

To work on Matplotlib sources, it is strongly recommended to set up an alternative
development environment, using the something like `virtual environments in python
<http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_, or a
`conda environment <http://conda.pydata.org/docs/using/envs.html>`_.

If you choose to use an already existing environment, and not a clean virtual or
conda environment, uninstall the current version of Matplotlib in that enviroment
using the same method used to install it.

If working on Matplotlib documentation only, the above steps are *not* absolutely
necessary.

We use `Git <https://git-scm.com/>`_ for version control and
`GitHub <https://github.com/>`_ for hosting our main repository.
Expand All @@ -71,6 +81,7 @@ You can check out the latest sources with the command (see

and navigate to the :file:`matplotlib` directory.


To make sure the tests run locally you must build against the correct version
of freetype. To configure the build system to fetch and build it either export
the env ``MPLLOCALFREETYPE`` as::
Expand Down
0