-
Notifications
You must be signed in to change notification settings - Fork 1
/
contributing.html
690 lines (654 loc) · 45 KB
/
contributing.html
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
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="author" title="About these documents" href="about.html" /><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Index" href="genindex.html" /><link rel="prev" title="Release notes" href="release_notes.html" />
<link rel="shortcut icon" href="_static/vunit.ico"/><!-- Generated with Sphinx 7.3.7 and Furo 2024.08.06 -->
<title>Contributing - VUnit documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">VUnit documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="_static/VUnit_logo.png" alt="Logo"/>
</div>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="blog/index.html">Blog</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Blog</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="blog/2023_08_26_vhdl_configurations.html">Improved Support for VHDL Configurations and OSVVM</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2023_04_01_vunit_phases.html">VUnit Phases</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2023_03_31_vunit_events.html">VUnit Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2022_09_19_vunit_user_conference.html">VUnit User Conference</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2022_09_06_vunit_and_other_frameworks.html">FAQ What is VUnit’s Relation to Other Verification Frameworks?</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2020_08_12_continuous_integration_with_vunit_action_in_10_lines_of_code.html">Continuous Integration With VUnit Action in 10 Lines of Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2018_09_22_sigasi_adds_full_vunit_support.html">Sigasi Adds Full VUnit Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2018_07_22_sigasi_deepens_its_commitment_to_the_vunit_testing_framework.html">Sigasi Deepens Its Commitment to the VUnit Testing Framework</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2018_03_22_vunit_community_developed_bfms.html">VUnit Community Developed BFMs</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2018_02_12_vunit3.html">VUnit 3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_12_14_vunit_bfms_as_simple_as_emailing.html">VUnit BFMs - as Simple as Emailing</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_11_23_vunit_matlab_integration.html">VUnit Matlab Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_11_07_vunit_3_0_while_waiting_for_vhdl_2017.html">VUnit 3.0 - While Waiting for VHDL-2017</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_10_31_vunit_3_0_color_logging.html">VUnit 3.0 Color Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_09_28_sigasi_adds_support_for_vunit_testing_framework.html">Sigasi Adds Support for VUnit Testing Framework</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_06_03_enable_your_simulator_to_handle_complex_top_level_generics.html">Enable Your Simulator to Handle Complex Top-Level Generics</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2017_01_12_vunit_getting_started_1_2_3.html">VUnit - Getting Started 1-2-3</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_11_22_vunit_the_best_value_for_initial_effort_part3.html">VUnit - The Best Value for Initial Effort - Part 3</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_11_16_vunit_the_best_value_for_initial_effort_part2.html">VUnit - The Best Value for Initial Effort - Part 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_11_15_vunit_the_best_value_for_initial_effort_part1.html">VUnit - The Best Value for Initial Effort - Part 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_08_08_making_osvvm_a_submodule.html">Making OSVVM a Git Submodule</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_02_21_improving_vhdl_testbench_design_with_message_passing.html">Improving VHDL Testbench Design with Message Passing</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_02_01_website_updates.html">Website Updates</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_01_29_chat_with_vunit_users_and_developers.html">Chat with VUnit Users and Developers</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2016_01_26_welcome_to_our_new_website.html">Welcome to Our New Website</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2015_12_15_free_and_open_source_verification_with_vunit_and_ghdl.html">Free and Open Source Verification with VUnit and GHDL</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2015_10_08_who_is_using_UVM.html">Who’s Using UVM (or Not) for FPGA Development, and Why?</a></li>
<li class="toctree-l2"><a class="reference internal" href="blog/2015_09_24_short_introduction_to_vunit.html">Short Introduction to VUnit</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">About</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">What is VUnit?</a></li>
<li class="toctree-l1"><a class="reference internal" href="installing.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="testimonials/testimonials.html">Testimonials</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="id/user_guide.html">Identity Package</a></li>
<li class="toctree-l1"><a class="reference internal" href="logging/user_guide.html">Logging Library User Guide</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="check/user_guide.html">Check Library User Guide</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Check Library User Guide</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="check/check_api.html"><em>check</em> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="check/checker_pkg.html"><em>checker</em> package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="run/user_guide.html">Run Library User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="com/user_guide.html">Communication Library User Guide</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="verification_components/user_guide.html">Verification Components User Guide</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Verification Components User Guide</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="verification_components/memory_model.html">Memory Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="verification_components/vci.html">Bus Master VCI</a></li>
<li class="toctree-l2"><a class="reference internal" href="verification_components/vci.html#stream-master-vci">Stream Master VCI</a></li>
<li class="toctree-l2"><a class="reference internal" href="verification_components/vci.html#stream-slave-vci">Stream Slave VCI</a></li>
<li class="toctree-l2"><a class="reference internal" href="verification_components/vci.html#synchronization-vci">Synchronization VCI</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="data_types/user_guide.html">Data Types User Guide</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Data Types User Guide</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="data_types/event_user_guide.html">VUnit Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_types/queue.html"><em>queue</em> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_types/integer_array.html"><em>integer_array</em> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_types/ext_string.html"><em>external string</em> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_types/ext_integer_vector.html"><em>external integer vector</em> package</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="cli.html">Command Line Interface</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="py/ui.html">Python Interface</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Python Interface</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="py/vunit.html">vunit.ui</a></li>
<li class="toctree-l2"><a class="reference internal" href="py/opts.html">Compilation Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="py/opts.html#simulation-options">Simulation Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hdl_libraries.html">HDL Libraries</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Continuous Integration</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="ci/intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci/script.html">Setup/configuration scripts</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci/container.html">Containers and/or Virtual Machines</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci/manual.html">Manual setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci/usecases.html">Practical use cases</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release notes</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a class="muted-link" href="https://github.com/VUnit/vunit/blob/master/docs/contributing.rst?plain=true" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div><div class="edit-this-page">
<a class="muted-link" href="https://github.com/VUnit/vunit/edit/master/docs/contributing.rst" title="Edit this page">
<svg><use href="#svg-pencil"></use></svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Link to this heading">¶</a></h1>
<p>Contributing in the form of code, feedback, ideas or bug reports are
welcome. Code contributions are expected to pass all tests and style
checks. If there are any problems let us know.</p>
<p>Before doing any major changes we recommend creating an issue or
chatting with us on gitter to discuss first. In this way you do not
get started on the wrong track and wasting time.</p>
<p>Being a testing framework we value automated testing and all
contributions in both the Python and VHDL/SystemVerilog domain are
expected to add new tests along with the new functionality.</p>
<section id="copyright">
<h2>Copyright<a class="headerlink" href="#copyright" title="Link to this heading">¶</a></h2>
<p>Any contribution must give the copyright to Lars Asplund.
This is necessary to manage the project freely.
Copyright is given by adding the copyright notice to the beginning of each file.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public</span>
<span class="c1"># License, v. 2.0. If a copy of the MPL was not distributed with this file,</span>
<span class="c1"># You can obtain one at http://mozilla.org/MPL/2.0/.</span>
<span class="c1">#</span>
<span class="c1"># Copyright (c) 2014-2024, Lars Asplund lars.anders.asplund@gmail.com</span>
</pre></div>
</div>
</section>
<section id="python-related">
<h2>Python related<a class="headerlink" href="#python-related" title="Link to this heading">¶</a></h2>
<section id="running-the-python-tests">
<h3>Running the Python tests<a class="headerlink" href="#running-the-python-tests" title="Link to this heading">¶</a></h3>
<p>The test suite is divided into three parts:</p>
<dl class="simple">
<dt><strong>tests/unit/</strong></dt><dd><p>Short and concise unit tests for internal modules and classes.</p>
</dd>
<dt><strong>tests/acceptance/</strong></dt><dd><p>End to end tests of public functionality. Depends on external tools
such as simulators.</p>
</dd>
<dt><strong>tests/lint/</strong></dt><dd><p>Style checks such as pycodestyle and license header verification.</p>
</dd>
</dl>
<p>The test suites must pass with Python 3.x as well as with all supported simulators.</p>
<p>For running the tests locally we recommend using <a class="reference external" href="https://pypi.python.org/pypi/pytest">pytest</a>.
In fact, <code class="docutils literal notranslate"><span class="pre">pytest</span></code> is required for running the acceptance tests, because some specific features are used for allowing
certain tests to fail.
See <a class="reference external" href="https://docs.pytest.org/en/latest/how-to/skipping.html" title="(in pytest v8.4.0.dev48)"><span>How to use skip and xfail to deal with tests that cannot succeed</span></a>.</p>
<div class="literal-block-wrapper docutils container" id="id2">
<div class="code-block-caption"><span class="caption-text">Example of running all unit tests</span><a class="headerlink" href="#id2" title="Link to this code">¶</a></div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pytest<span class="w"> </span>tests/unit/
</pre></div>
</div>
</div>
</section>
<section id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">¶</a></h3>
<p>Other than the dependencies required to use VUnit as a user the
following are also required for developers to run the test suite manually:</p>
<dl class="simple">
<dt><a class="reference external" href="https://pypi.python.org/pypi/pycodestyle">pycodestyle</a></dt><dd><p>Coding style check.</p>
</dd>
<dt><a class="reference external" href="https://pypi.python.org/pypi/pylint">pylint</a></dt><dd><p>Code analysis.</p>
</dd>
<dt><a class="reference external" href="http://www.mypy-lang.org/">mypy</a></dt><dd><p>Optional static typing for Python.</p>
</dd>
</dl>
</section>
<section id="code-coverage">
<h3>Code coverage<a class="headerlink" href="#code-coverage" title="Link to this heading">¶</a></h3>
<p>Code coverage can be measured using the
<a class="reference external" href="https://pypi.python.org/pypi/coverage">coverage</a> tool. The following
commands measure the code coverage while running the entire test suite:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">vunit/ > coverage run --branch --source vunit/ -m unittest discover tests/</span>
<span class="go">vunit/ > coverage html --directory=htmlcov</span>
<span class="go">vunit/ > open htmlcov/index.html</span>
</pre></div>
</div>
<p>Developers should ensure that new code is well covered. As of writing
this paragraph the total coverage was 92%. Missing coverage can be
analyzed by opening the generated <em>htmlcov/index.html</em> produced by the
above commands.</p>
</section>
</section>
<section id="vhdl-related">
<h2>VHDL related<a class="headerlink" href="#vhdl-related" title="Link to this heading">¶</a></h2>
<section id="running-the-vhdl-tests">
<h3>Running the VHDL tests<a class="headerlink" href="#running-the-vhdl-tests" title="Link to this heading">¶</a></h3>
<p>Each part of the VUnit VHDL code base has tests with a corresponding <code class="docutils literal notranslate"><span class="pre">run.py</span></code> file.
For example <a class="reference external" href="https://github.com/VUnit/vunit/tree/master/vunit/vhdl/verification_components/run.py/">vunit/vhdl/verification_components/run.py</a>.</p>
<section id="vhdl-example">
<h4>VHDL example<a class="headerlink" href="#vhdl-example" title="Link to this heading">¶</a></h4>
<div class="literal-block-wrapper docutils container" id="id3">
<div class="code-block-caption"><span class="caption-text">Example of running all verification component tests</span><a class="headerlink" href="#id3" title="Link to this code">¶</a></div>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>vunit/vhdl/verification_components/run.py
</pre></div>
</div>
</div>
</section>
</section>
<section id="coding-style">
<h3>Coding Style<a class="headerlink" href="#coding-style" title="Link to this heading">¶</a></h3>
<p>Contributions of VHDL code should blend in with the VUnit code style.</p>
<ul class="simple">
<li><p>Use lower case and <code class="docutils literal notranslate"><span class="pre">snake_case</span></code> for all identifiers and keywords.</p></li>
<li><p>Do not use prefixes or suffixes like <code class="docutils literal notranslate"><span class="pre">_c</span></code> or <code class="docutils literal notranslate"><span class="pre">_g</span></code> for constants.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">_t</span></code> suffix for type like <code class="docutils literal notranslate"><span class="pre"><typename>_t</span></code>.</p></li>
<li><p>Never use the fact that VHDL is case-insensitive; Do not use <code class="docutils literal notranslate"><span class="pre">Foo</span></code>
and <code class="docutils literal notranslate"><span class="pre">foo</span></code> to refer to the same identifier.</p></li>
<li><p>Name array types <code class="docutils literal notranslate"><span class="pre"><base_type_name>_vec_t</span></code></p></li>
<li><p>Name packages with suffix <code class="docutils literal notranslate"><span class="pre">_pkg</span></code></p></li>
<li><p>Name files the same as the package or entity they contain such as <code class="docutils literal notranslate"><span class="pre"><entity_name>.vhd</span></code></p></li>
<li><p>Never put more than one entity/package in the same file.</p></li>
<li><p>Keep the architecture in the same file as the entity unless there
are several architectures. When there are several architectures put
them all in separate files named
<code class="docutils literal notranslate"><span class="pre"><entity_name>_<architecture_name>.vhd</span></code>.</p></li>
<li><p>Put comments documenting functions and procedures above the
declaration in the package header rather than the definition in the
package body.</p></li>
</ul>
<p>Regarding formatting use look at other VHDL files and follow that
style. For example <a class="reference external" href="https://github.com/VUnit/vunit/tree/master/examples/vhdl/uart/src/uart_tx.vhd/">examples/vhdl/uart/src/uart_tx.vhd</a></p>
</section>
</section>
<section id="continous-integration">
<h2>Continous Integration<a class="headerlink" href="#continous-integration" title="Link to this heading">¶</a></h2>
<p>VUnit runs all test and lint checks on both GNU/Linux and Windows
with several versions of Python (typically, the oldest and newest
supported by both VUnit and the CI environment). <a class="reference external" href="https://github.com/ghdl/ghdl">GHDL</a>
is used to run the VHDL tests of all our libraries and examples.</p>
<p>All tests will be automatically run on any pull request and they are
expected to pass for us to approve the merge.</p>
<p>Any commit on master that has a successful CI run will automatically
update the <a class="reference external" href="https://vunit.github.io">VUnit website</a></p>
<section id="testing-with-tox">
<h3>Testing with Tox<a class="headerlink" href="#testing-with-tox" title="Link to this heading">¶</a></h3>
<p>VUnit uses the Python <a class="reference external" href="http://tox.readthedocs.org/">tox</a> tool in
the CI flow. Typically developers do not need to run this on their
local machine.</p>
<p>Tox makes it easier to automatically test VUnit in various
configurations. Tox automates creation of virtual environments and
installation of dependencies needed for testing. In fact, all of the
tests can be run in a single command:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">vunit/ > tox</span>
</pre></div>
</div>
<p>If tox is not available in your Python environment, it can be installed from
PyPI with pip:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">vunit/ > pip install tox</span>
</pre></div>
</div>
<p>For most developers, running the full testsuite will likely lead to failed test
cases because not all Python interpreters or HDL simulators are installed in
their environment. More focused testing is possible by specifying which tox
“environments” should be tested. For example, assume a developer uses Python 3.8
and Modelsim and would like to test changes using tools available in his
environment:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">vunit/ > tox -e py38-unit,py38-acceptance-modelsim</span>
</pre></div>
</div>
<p>A full list of test environments can be seen by issuing the following command:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">vunit/ > tox -l</span>
</pre></div>
</div>
</section>
<section id="making-releases">
<h3>Making releases<a class="headerlink" href="#making-releases" title="Link to this heading">¶</a></h3>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Reference <a class="reference internal" href="#release-notes-instructions"><span class="std std-ref">Release Notes Instructions</span></a> for creating relevant news fragments that will be added to the <a class="reference internal" href="release_notes.html#release-notes"><span class="std std-ref">Release notes</span></a>.</p>
</div>
<p>Releases are automatically made by GitHub Actions on any <code class="docutils literal notranslate"><span class="pre">master</span></code> commit which is tagged.</p>
<p>To create a new tagged release commit:</p>
<ul>
<li><p>Build the docs and review the content of <code class="docutils literal notranslate"><span class="pre">docs/news.inc</span></code>.</p>
<ul class="simple">
<li><p>If necessary, create additional news files and build the docs again.</p></li>
</ul>
</li>
<li><p>Add the news summary as the release notes and remove news fragments:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">mv</span> <span class="n">docs</span><span class="o">/</span><span class="n">news</span><span class="o">.</span><span class="n">inc</span> <span class="n">docs</span><span class="o">/</span><span class="n">release_notes</span><span class="o">/</span><span class="n">X</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span><span class="o">.</span><span class="n">rst</span>
<span class="n">git</span> <span class="n">add</span> <span class="n">docs</span><span class="o">/</span><span class="n">release_notes</span><span class="o">/</span><span class="n">X</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span><span class="o">.</span><span class="n">rst</span>
<span class="n">git</span> <span class="n">rm</span> <span class="o">-</span><span class="n">f</span> <span class="n">docs</span><span class="o">/</span><span class="n">news</span><span class="o">.</span><span class="n">d</span><span class="o">/*.</span><span class="n">rst</span>
</pre></div>
</div>
</li>
<li><dl class="simple">
<dt>Execute <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">tools/release.py</span> <span class="pre">create</span> <span class="pre">X.Y.Z</span></code>.</dt><dd><ul class="simple">
<li><p>Will make and tag a commit with the new <code class="docutils literal notranslate"><span class="pre">about.py</span></code> version, the release notes and removed news files.</p></li>
<li><p>Will make another commit setting <code class="docutils literal notranslate"><span class="pre">about.py</span></code> to the next development version.</p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>Push the tag to remote to trigger the release build.</dt><dd><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">vX.Y.Z</span></code></p></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>If the release build is successful, you can push the two commits to master.</dt><dd><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">push</span> <span class="pre">origin</span> <span class="pre">master</span></code></p></li>
<li><p>If, in the meantime, a new commit has come into origin/master the two commits have to be merged into origin/master.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
<p>The CI service makes a release by uploading a new package to PyPI when a tag named <code class="docutils literal notranslate"><span class="pre">vX.Y.Z</span></code> is found in Git.
A new release will not be made if:</p>
<ul class="simple">
<li><p>The <code class="docutils literal notranslate"><span class="pre">X.Y.Z</span></code> release is already on PyPI.</p></li>
<li><p>The repo tag does not exist.</p></li>
</ul>
</section>
</section>
<section id="submodule-related">
<h2>Submodule related<a class="headerlink" href="#submodule-related" title="Link to this heading">¶</a></h2>
<p>As of VUnit v4.7.0, the version of the submodules is printed in the corresponding <code class="docutils literal notranslate"><span class="pre">add_*</span></code> methods of
<a class="reference external" href="https://github.com/VUnit/vunit/tree/master/vunit/builtins.py/">builtins.py</a>.
Therefore, when bumping the submodules, maintainers/contributors need to remember modifying the string to match the new
version.</p>
<p>Furthermore, since OSVVM is tagged periodically, bumping from tag to tag is strongly suggested.</p>
</section>
<section id="release-notes-instructions">
<span id="id1"></span><h2>Release Notes Instructions<a class="headerlink" href="#release-notes-instructions" title="Link to this heading">¶</a></h2>
<p>The <a class="reference external" href="https://github.com/VUnit/vunit/tree/master/docs/news.d/">release notes directory</a> contains “newsfragments” which
are short (<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html">reST formatted</a>) files that
contain information for users.</p>
<p>Make sure to use full sentences in the <strong>past or present tense</strong> and use punctuation.</p>
<p>Each file should be named like <code class="docutils literal notranslate"><span class="pre"><issue</span> <span class="pre">#>.<type>.rst</span></code>, where <code class="docutils literal notranslate"><span class="pre"><issue</span> <span class="pre">#></span></code> is the
GitHub issue or pull request number, and <code class="docutils literal notranslate"><span class="pre"><type></span></code> is one of:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">breaking</span></code>:may break existing functionality; such as feature removal or behavior change.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">bugfix</span></code>: fixes a bug.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">doc</span></code>: related to the documentation.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">deprecation</span></code>: feature deprecation.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">feature</span></code>: backwards compatible feature addition or improvement.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">misc</span></code>: a ticket was closed, but it is not necessarily important for the user.</p></li>
</ul>
<p>For example: <code class="docutils literal notranslate"><span class="pre">123.feature.rst</span></code>, <code class="docutils literal notranslate"><span class="pre">456.bugfix.rst</span></code>.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p><code class="docutils literal notranslate"><span class="pre">towncrier</span></code> preserves multiple paragraphs and formatting
(code blocks, lists, and so on), but for entries other than features, it is usually better to stick
to a single paragraph to keep it concise.</p>
</div>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="genindex.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Index</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="release_notes.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Release notes</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2014-2024, Lars Asplund
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
<div class="icons">
<a class="muted-link fa-solid fa-brands fa-twitter" href="https://twitter.com/VUnitFramework" aria-label="Twitter @VUnitFramework"></a>
<a class="muted-link fa-solid fa-brands fa-gitter" href="https://gitter.im/VUnit/vunit" aria-label="Gitter VUnit/vunit"></a>
<a class="muted-link fa-solid fa-brands fa-github" href="https://github.com/VUnit/vunit" aria-label="GitHub VUnit/vunit"></a>
</div>
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Contributing</a><ul>
<li><a class="reference internal" href="#copyright">Copyright</a></li>
<li><a class="reference internal" href="#python-related">Python related</a><ul>
<li><a class="reference internal" href="#running-the-python-tests">Running the Python tests</a></li>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#code-coverage">Code coverage</a></li>
</ul>
</li>
<li><a class="reference internal" href="#vhdl-related">VHDL related</a><ul>
<li><a class="reference internal" href="#running-the-vhdl-tests">Running the VHDL tests</a><ul>
<li><a class="reference internal" href="#vhdl-example">VHDL example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#coding-style">Coding Style</a></li>
</ul>
</li>
<li><a class="reference internal" href="#continous-integration">Continous Integration</a><ul>
<li><a class="reference internal" href="#testing-with-tox">Testing with Tox</a></li>
<li><a class="reference internal" href="#making-releases">Making releases</a></li>
</ul>
</li>
<li><a class="reference internal" href="#submodule-related">Submodule related</a></li>
<li><a class="reference internal" href="#release-notes-instructions">Release Notes Instructions</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=5fa4622c"></script>
</body>
</html>