Update contribution instructions

Test

Update contribution instructions

Tmp

Tmp

Author: lukelbd

.gitattributes

@@ -1,6 +1,3 @@
-# Strips notebook output for diffs and when staging files
-# Download with 'pip install nbstripout'
 # See: https://github.com/kynan/nbstripout
 *.ipynb filter=nbstripout
 *.ipynb diff=ipynb
-

HOWTOCONTRIBUTE.rst

@@ -70,15 +70,9 @@ Some helpful ReST guides are located `here <http://docutils.sourceforge.net/docs
 
     The built documentation should be available in the ``docs/_build/html``.
 
-Preparing Pull Requests
+Preparing pull requests
 =======================
 
-#. If you intend to make changes / add examples to the ipython notebooks,
-   you need to install `nbstripout <https://github.com/kynan/nbstripout>`__
-   with ``pip install nbstripout``. This deletes notebook cell output so
-   `nbsphinx <https://nbsphinx.readthedocs.io/en/0.4.3/>`__ always reruns them
-   after git pushes.
-
 #. Fork the
    `proplot GitHub repository <https://github.com/lukelbd/proplot>`__.  It's
    fine to use ``proplot`` as your fork repository name because it will live
@@ -97,6 +91,23 @@ Preparing Pull Requests
    If you need some help with git, follow the
    `quick start guide <https://git.wiki.kernel.org/index.php/QuickStart>`__.
 
+#. If you intend to make changes / add examples to the ipython notebooks,
+   you need to install and configure
+   `nbstripout <https://github.com/kynan/nbstripout>`__ with
+
+   .. code-block:: bash
+
+      cd proplot
+      pip install nbstripout
+      git config --local include.path ../.gitconfig
+
+   This strips notebook cell output when files are staged, which reduces the
+   repo storage size and lets us use
+   `nbsphinx <https://nbsphinx.readthedocs.io/en/0.4.3/>`__
+   to test each ``git push``, since ``nbsphinx`` must then re-run every cell.
+   The ``git config`` command configures the filters referenced in
+   ``proplot/.gitattributes`` with the options declared in ``proplot/.gitconfig``.
+
 #. Make an editable install of proplot by running:
 
    .. code-block:: bash

docs/.gitconfig

@@ -1,3 +1,4 @@
+# See: https://github.com/kynan/nbstripout
 [diff "ipynb"]
 	textconv = nbstripout -t
 [filter "nbstripout"]

docs/sphinxext/custom_roles.py

@@ -3,7 +3,6 @@
 from proplot import rc
 
 # Adapted from matplotlib
-# TODO: Understand what the hell is going on here
 def get_nodes(rawtext, text, inliner):
     rctext = (f"rc['{text}']" if '.' in text else f'rc.{text}')
     rendered = nodes.Text(rctext)