From 801185c30efc2c9d4b7c8c4a577d9261c7babb05 Mon Sep 17 00:00:00 2001 From: Eugene Yurtsev Date: Thu, 1 Jan 2015 13:16:42 -0500 Subject: [PATCH] DOC: instructions on installing matplotlib for dev --- doc/devel/gitwash/index.rst | 2 +- doc/devel/gitwash/matplotlib_for_dev.rst | 17 +++++++++++++++++ ...pment.rst => setting_up_for_development.rst} | 5 +++-- 3 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 doc/devel/gitwash/matplotlib_for_dev.rst rename doc/devel/gitwash/{git_development.rst => setting_up_for_development.rst} (65%) diff --git a/doc/devel/gitwash/index.rst b/doc/devel/gitwash/index.rst index c9567cc7e359..53d884e711be 100644 --- a/doc/devel/gitwash/index.rst +++ b/doc/devel/gitwash/index.rst @@ -11,6 +11,6 @@ Contents: git_intro git_install following_latest - git_development + setting_up_for_development git_resources patching diff --git a/doc/devel/gitwash/matplotlib_for_dev.rst b/doc/devel/gitwash/matplotlib_for_dev.rst new file mode 100644 index 000000000000..d1c6373c2168 --- /dev/null +++ b/doc/devel/gitwash/matplotlib_for_dev.rst @@ -0,0 +1,17 @@ +.. _matplotlib-for-dev: + +=================================================== + Install for matplotlib source for development +=================================================== + +After obtaining a local copy of the matpotlib source code (:ref:`set-up-fork`), +navigate to the matplotlib directory and run the following in the shell: + +:: + + python setup.py develop + +This installs matplotlib for development (i.e., builds everything and places the +symbolic links back to the source code). + +You may want to consider setting up a `virtual environment `_. diff --git a/doc/devel/gitwash/git_development.rst b/doc/devel/gitwash/setting_up_for_development.rst similarity index 65% rename from doc/devel/gitwash/git_development.rst rename to doc/devel/gitwash/setting_up_for_development.rst index 3808ca9fa1c4..aa30be730d9c 100644 --- a/doc/devel/gitwash/git_development.rst +++ b/doc/devel/gitwash/setting_up_for_development.rst @@ -1,7 +1,7 @@ -.. _git-development: +.. _setting_up_for_development: ===================== - Git for development + Setting up for development ===================== Contents: @@ -11,5 +11,6 @@ Contents: forking_hell set_up_fork + matplotlib_for_dev configure_git development_workflow