-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathdevelopment_setup.html
More file actions
873 lines (704 loc) · 34.5 KB
/
development_setup.html
File metadata and controls
873 lines (704 loc) · 34.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Setting up Matplotlib for development — Matplotlib 3.6.0 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=9b1a4fa89bdd0e95b23b" rel="stylesheet">
<link href="../_static/styles/pydata-sphinx-theme.css?digest=9b1a4fa89bdd0e95b23b" rel="stylesheet">
<link rel="stylesheet"
href="../_static/vendor/fontawesome/6.1.2/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/css/style.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css?v3.6.0-2-g33c6538897" />
<link rel="stylesheet" type="text/css" href="../_static/mpl.css?v3.6.0-2-g33c6538897" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=9b1a4fa89bdd0e95b23b">
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v3.6.0-2-g33c6538897"></script>
<script src="../_static/jquery.js?v3.6.0-2-g33c6538897"></script>
<script src="../_static/underscore.js?v3.6.0-2-g33c6538897"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v3.6.0-2-g33c6538897"></script>
<script src="../_static/doctools.js?v3.6.0-2-g33c6538897"></script>
<script src="../_static/clipboard.min.js?v3.6.0-2-g33c6538897"></script>
<script src="../_static/copybutton.js?v3.6.0-2-g33c6538897"></script>
<script src="../_static/design-tabs.js?v3.6.0-2-g33c6538897"></script>
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'devel/development_setup';</script>
<script>
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.6.0';
</script>
<link rel="canonical" href="https://matplotlib.org/stable/devel/development_setup.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.6.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Testing" href="testing.html" />
<link rel="prev" title="Bug triaging and issue curation" href="triage.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode="">
<input type="checkbox" class="sidebar-toggle" name="__primary" id="__primary">
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox" class="sidebar-toggle" name="__secondary" id="__secondary">
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center" action="../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false">
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar" id="navbar-main"><div class="bd-header__inner bd-page-width">
<label class="sidebar-toggle primary-toggle" for="__primary">
<span class="fas fa-bars"></span>
</label>
<div id="navbar-start">
<a class="navbar-brand logo" href="../index.html">
<img src="../_static/images/logo2.svg" class="logo__image only-light" alt="Logo image">
<img src="../_static/images/logo_dark.svg" class="logo__image only-dark" alt="Logo image">
</a>
</div>
<div class="col-lg-9 navbar-header-items">
<div id="navbar-center" class="mr-auto">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Release notes</a>
</li>
</ul>
</div>
</div>
<div id="navbar-end">
<div class="navbar-end-item navbar-end__search-button-container">
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search">
<i class="fas fa-search"></i>
</button>
</div>
<div class="navbar-end-item">
<span class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle">
<a class="theme-switch" data-mode="light"><i class="fas fa-sun"></i></a>
<a class="theme-switch" data-mode="dark"><i class="far fa-moon"></i></a>
<a class="theme-switch" data-mode="auto"><i class="fas fa-adjust"></i></a>
</span>
</div>
<div class="navbar-end-item">
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank"><span><i class="fab fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank"><span><i class="fab fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank"><span><i class="fab fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank"><span><i class="fab fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul>
</div>
</div>
</div>
<div class="search-button-container--mobile">
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search">
<i class="fas fa-search"></i>
</button>
</div>
<label class="sidebar-toggle secondary-toggle" for="__secondary">
<span class="fas fa-outdent"></span>
</label>
</div>
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Release notes</a>
</li>
</ul>
</div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-end-item">
<span class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle">
<a class="theme-switch" data-mode="light"><i class="fas fa-sun"></i></a>
<a class="theme-switch" data-mode="dark"><i class="far fa-moon"></i></a>
<a class="theme-switch" data-mode="auto"><i class="fas fa-adjust"></i></a>
</span>
</div>
<div class="navbar-end-item">
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank"><span><i class="fab fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank"><span><i class="fab fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank"><span><i class="fab fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank"><span><i class="fab fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul>
</div>
</div>
</div>
<div class="sidebar-start-items sidebar-primary__section">
<div class="sidebar-start-items__item"><nav class="bd-links" id="bd-docs-nav" aria-label="Section navigation">
<p class="bd-links__title" role="heading" aria-level="1">
Section Navigation
</p>
<div class="bd-toc-item navbar-nav">
<ul class="current nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="contributing.html">
Contributing
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="triage.html">
Bug triaging and issue curation
</a>
</li>
<li class="toctree-l1 current active">
<a class="current reference internal" href="#">
Setting up Matplotlib for development
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="testing.html">
Testing
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="documenting_mpl.html">
Writing documentation
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="style_guide.html">
Documentation style guide
</a>
</li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="gitwash/index.html">
Working with
<em>
Matplotlib
</em>
source code
</a>
<input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/>
<label class="toctree-toggle" for="toctree-checkbox-1">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="gitwash/git_intro.html">
Introduction
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="gitwash/git_install.html">
Install git
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="gitwash/following_latest.html">
Following the latest source
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="gitwash/patching.html">
Making a patch
</a>
</li>
<li class="toctree-l2 has-children">
<a class="reference internal" href="gitwash/git_development.html">
Git for development
</a>
<input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/>
<label class="toctree-toggle" for="toctree-checkbox-2">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l3">
<a class="reference internal" href="gitwash/forking_hell.html">
Making your own copy (fork) of Matplotlib
</a>
</li>
<li class="toctree-l3">
<a class="reference internal" href="gitwash/set_up_fork.html">
Set up your fork
</a>
</li>
<li class="toctree-l3">
<a class="reference internal" href="gitwash/configure_git.html">
Configure git
</a>
</li>
<li class="toctree-l3">
<a class="reference internal" href="gitwash/development_workflow.html">
Development workflow
</a>
</li>
<li class="toctree-l3">
<a class="reference internal" href="gitwash/maintainer_workflow.html">
Maintainer workflow
</a>
</li>
</ul>
</li>
<li class="toctree-l2">
<a class="reference internal" href="gitwash/git_resources.html">
git resources
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="gitwash/dot2_dot3.html">
Two and three dots in difference specs
</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<a class="reference internal" href="coding_guide.html">
Pull request guidelines
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="release_guide.html">
Release guide
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="dependencies.html">
Dependencies
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="min_dep_policy.html">
Minimum version of dependencies policy
</a>
</li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="MEP/index.html">
Matplotlib Enhancement Proposals
</a>
<input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/>
<label class="toctree-toggle" for="toctree-checkbox-3">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="MEP/template.html">
MEP Template
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP08.html">
MEP8: PEP8
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP09.html">
MEP9: Global interaction manager
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP10.html">
MEP10: Docstring consistency
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP11.html">
MEP11: Third-party dependencies
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP12.html">
MEP12: Improve Gallery and Examples
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP13.html">
MEP13: Use properties for Artists
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP14.html">
MEP14: Text handling
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP15.html">
MEP15: Fix axis autoscaling when limits are specified for one axis only
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP19.html">
MEP19: Continuous Integration
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP21.html">
MEP21: color and cm refactor
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP22.html">
MEP22: Toolbar rewrite
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP23.html">
MEP23: Multiple Figures per GUI window
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP24.html">
MEP24: Negative radius in polar plots
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP25.html">
MEP25: Serialization
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP26.html">
MEP26: Artist styling
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP27.html">
MEP27: Decouple pyplot from backends
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP28.html">
MEP28: Remove Complexity from Axes.boxplot
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="MEP/MEP29.html">
MEP29: Text light markup
</a>
</li>
</ul>
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="license.html">
Licenses
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="color_changes.html">
Default color changes
</a>
</li>
</ul>
</div>
</nav>
</div>
</div>
<div class="sidebar-end-items sidebar-primary__section">
<div class="sidebar-end-items__item">
</div>
</div>
</div>
<main class="bd-main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
</div>
<article class="bd-article" role="main">
<section id="setting-up-matplotlib-for-development">
<span id="installing-for-devs"></span><h1>Setting up Matplotlib for development<a class="headerlink" href="#setting-up-matplotlib-for-development" title="Permalink to this heading">#</a></h1>
<p>To set up Matplotlib for development follow these steps:</p>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#retrieve-the-latest-version-of-the-code" id="id1">Retrieve the latest version of the code</a></p></li>
<li><p><a class="reference internal" href="#create-a-dedicated-environment" id="id2">Create a dedicated environment</a></p></li>
<li><p><a class="reference internal" href="#install-matplotlib-in-editable-mode" id="id3">Install Matplotlib in editable mode</a></p></li>
<li><p><a class="reference internal" href="#install-additional-development-dependencies" id="id4">Install additional development dependencies</a></p></li>
<li><p><a class="reference internal" href="#install-pre-commit-hooks-optional" id="id5">Install pre-commit hooks (optional)</a></p></li>
</ul>
</nav>
<section id="retrieve-the-latest-version-of-the-code">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Retrieve the latest version of the code</a><a class="headerlink" href="#retrieve-the-latest-version-of-the-code" title="Permalink to this heading">#</a></h2>
<p>Matplotlib is hosted at <a class="reference external" href="https://github.com/matplotlib/matplotlib.git">https://github.com/matplotlib/matplotlib.git</a>.</p>
<p>You can retrieve the latest sources with the command (see
<a class="reference internal" href="gitwash/set_up_fork.html#set-up-fork"><span class="std std-ref">Set up your fork</span></a> for more details)</p>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio">
</input><label class="sd-tab-label" for="sd-tab-item-0">
https</label><div class="sd-tab-content docutils">
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/matplotlib/matplotlib.git
</pre></div>
</div>
</div>
<input id="sd-tab-item-1" name="sd-tab-set-0" type="radio">
</input><label class="sd-tab-label" for="sd-tab-item-1">
ssh</label><div class="sd-tab-content docutils">
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone git@github.com:matplotlib/matplotlib.git
</pre></div>
</div>
<p>This requires you to setup an <a class="reference external" href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh">SSH key</a> in advance, but saves you from
typing your password at every connection.</p>
</div>
</div>
<p>This will place the sources in a directory <code class="file docutils literal notranslate"><span class="pre">matplotlib</span></code> below your
current working directory. Change into this directory:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">matplotlib</span>
</pre></div>
</div>
</section>
<section id="create-a-dedicated-environment">
<span id="dev-environment"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Create a dedicated environment</a><a class="headerlink" href="#create-a-dedicated-environment" title="Permalink to this heading">#</a></h2>
<p>You should set up a dedicated environment to decouple your Matplotlib
development from other Python and Matplotlib installations on your system.</p>
<p>The simplest way to do this is to use either Python's virtual environment
<a class="reference external" href="https://docs.python.org/3/library/venv.html">venv</a> or <a class="reference external" href="https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html">conda</a>.</p>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-2" name="sd-tab-set-1" type="radio">
</input><label class="sd-tab-label" for="sd-tab-item-2">
venv environment</label><div class="sd-tab-content docutils">
<p>Create a new <a class="reference external" href="https://docs.python.org/3/library/venv.html">venv</a> environment with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">venv</span> <span class="o"><</span><span class="n">file</span> <span class="n">folder</span> <span class="n">location</span><span class="o">></span>
</pre></div>
</div>
<p>and activate it with one of the following</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">source</span> <span class="o"><</span><span class="n">file</span> <span class="n">folder</span> <span class="n">location</span><span class="o">>/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span> <span class="c1"># Linux/macOS</span>
<span class="o"><</span><span class="n">file</span> <span class="n">folder</span> <span class="n">location</span><span class="o">></span>\<span class="n">Scripts</span>\<span class="n">activate</span><span class="o">.</span><span class="n">bat</span> <span class="c1"># Windows cmd.exe</span>
<span class="o"><</span><span class="n">file</span> <span class="n">folder</span> <span class="n">location</span><span class="o">></span>\<span class="n">Scripts</span>\<span class="n">Activate</span><span class="o">.</span><span class="n">ps1</span> <span class="c1"># Windows PowerShell</span>
</pre></div>
</div>
</div>
<input id="sd-tab-item-3" name="sd-tab-set-1" type="radio">
</input><label class="sd-tab-label" for="sd-tab-item-3">
conda environment</label><div class="sd-tab-content docutils">
<p>Create a new <a class="reference external" href="https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html">conda</a> environment with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">env</span> <span class="n">create</span> <span class="o">-</span><span class="n">f</span> <span class="n">environment</span><span class="o">.</span><span class="n">yml</span>
</pre></div>
</div>
<p>You can use <code class="docutils literal notranslate"><span class="pre">mamba</span></code> instead of <code class="docutils literal notranslate"><span class="pre">conda</span></code> in the above command if
you have <a class="reference external" href="https://mamba.readthedocs.io/en/latest/">mamba</a> installed.</p>
<p>Activate the environment using</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">activate</span> <span class="n">mpl</span><span class="o">-</span><span class="n">dev</span>
</pre></div>
</div>
</div>
</div>
<p>Remember to activate the environment whenever you start working on Matplotlib.</p>
</section>
<section id="install-matplotlib-in-editable-mode">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Install Matplotlib in editable mode</a><a class="headerlink" href="#install-matplotlib-in-editable-mode" title="Permalink to this heading">#</a></h2>
<p>Install Matplotlib in editable mode from the <code class="file docutils literal notranslate"><span class="pre">matplotlib</span></code> directory
using the command</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">ve</span> <span class="o">.</span>
</pre></div>
</div>
<p>The 'editable/develop mode', builds everything and places links in your Python
environment so that Python will be able to import Matplotlib from your
development source directory. This allows you to import your modified version
of Matplotlib without re-installing after every change. Note that this is only
true for <code class="docutils literal notranslate"><span class="pre">*.py</span></code> files. If you change the C-extension source (which might
also happen if you change branches) you will have to re-run
<code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-ve</span> <span class="pre">.</span></code></p>
</section>
<section id="install-additional-development-dependencies">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Install additional development dependencies</a><a class="headerlink" href="#install-additional-development-dependencies" title="Permalink to this heading">#</a></h2>
<p>See <a class="reference internal" href="dependencies.html#development-dependencies"><span class="std std-ref">Dependencies for building Matplotlib</span></a>.</p>
</section>
<section id="install-pre-commit-hooks-optional">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Install pre-commit hooks (optional)</a><a class="headerlink" href="#install-pre-commit-hooks-optional" title="Permalink to this heading">#</a></h2>
<p><a class="reference external" href="https://pre-commit.com/">pre-commit</a> hooks automatically check flake8 and
other style issues when you run <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span></code>. The hooks are defined in the
top level <code class="docutils literal notranslate"><span class="pre">.pre-commit-config.yaml</span></code> file. To install the hooks</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="n">pre</span><span class="o">-</span><span class="n">commit</span>
<span class="n">pre</span><span class="o">-</span><span class="n">commit</span> <span class="n">install</span>
</pre></div>
</div>
<p>The hooks can also be run manually. All the hooks can be run, in order as
listed in <code class="docutils literal notranslate"><span class="pre">.pre-commit-config.yaml</span></code>, against the full codebase with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pre</span><span class="o">-</span><span class="n">commit</span> <span class="n">run</span> <span class="o">--</span><span class="nb">all</span><span class="o">-</span><span class="n">files</span>
</pre></div>
</div>
<p>To run a particular hook manually, run <code class="docutils literal notranslate"><span class="pre">pre-commit</span> <span class="pre">run</span></code> with the hook id</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pre</span><span class="o">-</span><span class="n">commit</span> <span class="n">run</span> <span class="o"><</span><span class="n">hook</span> <span class="nb">id</span><span class="o">></span> <span class="o">--</span><span class="nb">all</span><span class="o">-</span><span class="n">files</span>
</pre></div>
</div>
</section>
</section>
</article>
</div>
<div class="bd-sidebar-secondary bd-toc">
<div class="toc-item">
<div class="tocsection onthispage">
<i class="fas fa-list"></i> On this page
</div>
<nav id="bd-toc-nav" class="page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#retrieve-the-latest-version-of-the-code">
Retrieve the latest version of the code
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#create-a-dedicated-environment">
Create a dedicated environment
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#install-matplotlib-in-editable-mode">
Install Matplotlib in editable mode
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#install-additional-development-dependencies">
Install additional development dependencies
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#install-pre-commit-hooks-optional">
Install pre-commit hooks (optional)
</a>
</li>
</ul>
</nav>
</div>
<div class="toc-item">
</div>
<div class="toc-item">
<div class="tocsection sourcelink">
<a href="../_sources/devel/development_setup.rst.txt">
<i class="fas fa-file-alt"></i> Show Source
</a>
</div>
</div>
</div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner">
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<div id="unreleased-message"> You are reading an old version of the documentation (v3.6.0). For the latest version see <a href="https://matplotlib.org/stable/devel/development_setup.html">https://matplotlib.org/stable/devel/development_setup.html</a></div>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=9b1a4fa89bdd0e95b23b"></script>
<footer class="bd-footer"><div class="bd-footer__inner container">
<div class="footer-item">
<p class="copyright">
© Copyright 2002–2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012–2022 The Matplotlib development team.<br>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.1.1.<br>
</p>
</div>
</div>
</footer>
</body>
</html>