Merge pull request #7229 from NelleV/eyurstev_DOC_development

DOC: instructions on installing matplotlib for dev

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

doc/devel/gitwash/matplotlib_for_dev.rst

@@ -0,0 +1,27 @@
+.. _matplotlib-for-dev:
+
+=================================================
+Installing matplotlib from 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
+
+or::
+  
+   pip install -v -e .
+
+This installs matplotlib for development (i.e., builds everything and places
+the symbolic links back to the source code). This command has to be called
+everytime a `c` file is changed. Note that changing branches may change the
+`c`-code.
+
+When working on bleeding edge packages, 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.
+

doc/devel/gitwash/setting_up_for_development.rst

@@ -0,0 +1,17 @@
+.. _setting_up_for_development:
+
+==========================
+Setting up for development
+==========================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   forking_hell
+   set_up_fork
+   matplotlib_for_dev
+   configure_git
+   development_workflow
+   dot2_dot3

doc/devel/release_guide.rst

@@ -1,8 +1,8 @@
 .. _release-guide:
 
-**************************
-Doing a matplotlib release
-**************************
+*************
+Release Guide
+*************
 
 A guide for developers who are doing a matplotlib release.