Skip to content

Commit 6639762

Browse files
committed
Make development setup section headers instruction steps
1 parent 3b79f63 commit 6639762

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

doc/devel/development_setup.rst

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@
44
Setting up Matplotlib for development
55
=====================================
66

7-
Retrieving the latest version of the code
8-
=========================================
7+
To set up Matplotlib for development follow these steps:
8+
9+
.. contents::
10+
:local:
11+
12+
Retrieve the latest version of the code
13+
=======================================
914

1015
Matplotlib is hosted at https://github.com/matplotlib/matplotlib.git.
1116

@@ -23,8 +28,8 @@ if you are using 2-factor authentication.
2328

2429
.. _dev-environment:
2530

26-
Creating a dedicated environment
27-
================================
31+
Create a dedicated environment
32+
==============================
2833
You should set up a dedicated environment to decouple your Matplotlib
2934
development from other Python and Matplotlib installations on your system.
3035

@@ -68,11 +73,8 @@ Finish the install by the following command::
6873

6974
pip install -e .
7075

71-
Whenever you plan to work on Matplotlib, remember to ``conda activate mpl-dev``
72-
in your shell.
73-
74-
Installing Matplotlib in editable mode
75-
======================================
76+
Install Matplotlib in editable mode
77+
===================================
7678
Install Matplotlib in editable mode from the :file:`matplotlib` directory
7779
using the command ::
7880

@@ -86,8 +88,8 @@ true for ``*.py`` files. If you change the C-extension source (which might
8688
also happen if you change branches) you will have to re-run
8789
``python -m pip install -ve .``
8890

89-
Installing pre-commit hooks
90-
===========================
91+
Install pre-commit hooks (optional)
92+
===================================
9193
You can optionally install `pre-commit <https://pre-commit.com/>`_ hooks.
9294
These will automatically check flake8 and other style issues when you run
9395
``git commit``. The hooks are defined in the top level
@@ -105,6 +107,6 @@ To run a particular hook manually, run ``pre-commit run`` with the hook id ::
105107

106108
pre-commit run <hook id> --all-files
107109

108-
Installing additional dependencies for development
109-
==================================================
110+
Install additional development dependencies
111+
===========================================
110112
See :ref:`development-dependencies`.

0 commit comments

Comments
 (0)