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 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
|
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="pdoc $VERSION"/>
<title>flavors_rst API documentation</title>
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
<style>/*! syntax-highlighting.css */pre{line-height:125%;}span.linenos{color:inherit; background-color:transparent; padding-left:5px; padding-right:20px;}.pdoc-code .hll{background-color:#ffffcc}.pdoc-code{background:#f8f8f8;}.pdoc-code .c{color:#3D7B7B; font-style:italic}.pdoc-code .err{border:1px solid #FF0000}.pdoc-code .k{color:#008000; font-weight:bold}.pdoc-code .o{color:#666666}.pdoc-code .ch{color:#3D7B7B; font-style:italic}.pdoc-code .cm{color:#3D7B7B; font-style:italic}.pdoc-code .cp{color:#9C6500}.pdoc-code .cpf{color:#3D7B7B; font-style:italic}.pdoc-code .c1{color:#3D7B7B; font-style:italic}.pdoc-code .cs{color:#3D7B7B; font-style:italic}.pdoc-code .gd{color:#A00000}.pdoc-code .ge{font-style:italic}.pdoc-code .gr{color:#E40000}.pdoc-code .gh{color:#000080; font-weight:bold}.pdoc-code .gi{color:#008400}.pdoc-code .go{color:#717171}.pdoc-code .gp{color:#000080; font-weight:bold}.pdoc-code .gs{font-weight:bold}.pdoc-code .gu{color:#800080; font-weight:bold}.pdoc-code .gt{color:#0044DD}.pdoc-code .kc{color:#008000; font-weight:bold}.pdoc-code .kd{color:#008000; font-weight:bold}.pdoc-code .kn{color:#008000; font-weight:bold}.pdoc-code .kp{color:#008000}.pdoc-code .kr{color:#008000; font-weight:bold}.pdoc-code .kt{color:#B00040}.pdoc-code .m{color:#666666}.pdoc-code .s{color:#BA2121}.pdoc-code .na{color:#687822}.pdoc-code .nb{color:#008000}.pdoc-code .nc{color:#0000FF; font-weight:bold}.pdoc-code .no{color:#880000}.pdoc-code .nd{color:#AA22FF}.pdoc-code .ni{color:#717171; font-weight:bold}.pdoc-code .ne{color:#CB3F38; font-weight:bold}.pdoc-code .nf{color:#0000FF}.pdoc-code .nl{color:#767600}.pdoc-code .nn{color:#0000FF; font-weight:bold}.pdoc-code .nt{color:#008000; font-weight:bold}.pdoc-code .nv{color:#19177C}.pdoc-code .ow{color:#AA22FF; font-weight:bold}.pdoc-code .w{color:#bbbbbb}.pdoc-code .mb{color:#666666}.pdoc-code .mf{color:#666666}.pdoc-code .mh{color:#666666}.pdoc-code .mi{color:#666666}.pdoc-code .mo{color:#666666}.pdoc-code .sa{color:#BA2121}.pdoc-code .sb{color:#BA2121}.pdoc-code .sc{color:#BA2121}.pdoc-code .dl{color:#BA2121}.pdoc-code .sd{color:#BA2121; font-style:italic}.pdoc-code .s2{color:#BA2121}.pdoc-code .se{color:#AA5D1F; font-weight:bold}.pdoc-code .sh{color:#BA2121}.pdoc-code .si{color:#A45A77; font-weight:bold}.pdoc-code .sx{color:#008000}.pdoc-code .sr{color:#A45A77}.pdoc-code .s1{color:#BA2121}.pdoc-code .ss{color:#19177C}.pdoc-code .bp{color:#008000}.pdoc-code .fm{color:#0000FF}.pdoc-code .vc{color:#19177C}.pdoc-code .vg{color:#19177C}.pdoc-code .vi{color:#19177C}.pdoc-code .vm{color:#19177C}.pdoc-code .il{color:#666666}</style>
<style>/*! theme.css */:root{--pdoc-background:#fff;}.pdoc{--text:#212529;--muted:#6c757d;--link:#3660a5;--link-hover:#1659c5;--code:#f8f8f8;--active:#fff598;--accent:#eee;--accent2:#c1c1c1;--nav-hover:rgba(255, 255, 255, 0.5);--name:#0066BB;--def:#008800;--annotation:#007020;}</style>
<style>/*! layout.css */html, body{width:100%;height:100%;}html, main{scroll-behavior:smooth;}body{background-color:var(--pdoc-background);}@media (max-width:769px){#navtoggle{cursor:pointer;position:absolute;width:50px;height:40px;top:1rem;right:1rem;border-color:var(--text);color:var(--text);display:flex;opacity:0.8;z-index:999;}#navtoggle:hover{opacity:1;}#togglestate + div{display:none;}#togglestate:checked + div{display:inherit;}main, header{padding:2rem 3vw;}header + main{margin-top:-3rem;}.git-button{display:none !important;}nav input[type="search"]{max-width:77%;}nav input[type="search"]:first-child{margin-top:-6px;}nav input[type="search"]:valid ~ *{display:none !important;}}@media (min-width:770px){:root{--sidebar-width:clamp(12.5rem, 28vw, 22rem);}nav{position:fixed;overflow:auto;height:100vh;width:var(--sidebar-width);}main, header{padding:3rem 2rem 3rem calc(var(--sidebar-width) + 3rem);width:calc(54rem + var(--sidebar-width));max-width:100%;}header + main{margin-top:-4rem;}#navtoggle{display:none;}}#togglestate{position:absolute;height:0;opacity:0;}nav.pdoc{--pad:clamp(0.5rem, 2vw, 1.75rem);--indent:1.5rem;background-color:var(--accent);border-right:1px solid var(--accent2);box-shadow:0 0 20px rgba(50, 50, 50, .2) inset;padding:0 0 0 var(--pad);overflow-wrap:anywhere;scrollbar-width:thin; scrollbar-color:var(--accent2) transparent; z-index:1}nav.pdoc::-webkit-scrollbar{width:.4rem; }nav.pdoc::-webkit-scrollbar-thumb{background-color:var(--accent2); }nav.pdoc > div{padding:var(--pad) 0;}nav.pdoc .module-list-button{display:inline-flex;align-items:center;color:var(--text);border-color:var(--muted);margin-bottom:1rem;}nav.pdoc .module-list-button:hover{border-color:var(--text);}nav.pdoc input[type=search]{display:block;outline-offset:0;width:calc(100% - var(--pad));}nav.pdoc .logo{max-width:calc(100% - var(--pad));max-height:35vh;display:block;margin:0 auto 1rem;transform:translate(calc(-.5 * var(--pad)), 0);}nav.pdoc ul{list-style:none;padding-left:0;}nav.pdoc > div > ul{margin-left:calc(0px - var(--pad));}nav.pdoc li a{padding:.2rem 0 .2rem calc(var(--pad) + var(--indent));}nav.pdoc > div > ul > li > a{padding-left:var(--pad);}nav.pdoc li{transition:all 100ms;}nav.pdoc li:hover{background-color:var(--nav-hover);}nav.pdoc a, nav.pdoc a:hover{color:var(--text);}nav.pdoc a{display:block;}nav.pdoc > h2:first-of-type{margin-top:1.5rem;}nav.pdoc .class:before{content:"class ";color:var(--muted);}nav.pdoc .function:after{content:"()";color:var(--muted);}nav.pdoc footer:before{content:"";display:block;width:calc(100% - var(--pad));border-top:solid var(--accent2) 1px;margin-top:1.5rem;padding-top:.5rem;}nav.pdoc footer{font-size:small;}</style>
<style>/*! content.css */.pdoc{color:var(--text);box-sizing:border-box;line-height:1.5;background:none;}.pdoc .pdoc-button{cursor:pointer;display:inline-block;border:solid black 1px;border-radius:2px;font-size:.75rem;padding:calc(0.5em - 1px) 1em;transition:100ms all;}.pdoc .alert{padding:1rem 1rem 1rem calc(1.5rem + 24px);border:1px solid transparent;border-radius:.25rem;background-repeat:no-repeat;background-position:.75rem center;margin-bottom:1rem;}.pdoc .alert > em{display:none;}.pdoc .alert > *:last-child{margin-bottom:0;}.pdoc .alert.note{color:#084298;background-color:#cfe2ff;border-color:#b6d4fe;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23084298%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8%2016A8%208%200%201%200%208%200a8%208%200%200%200%200%2016zm.93-9.412-1%204.705c-.07.34.029.533.304.533.194%200%20.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703%200-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381%202.29-.287zM8%205.5a1%201%200%201%201%200-2%201%201%200%200%201%200%202z%22/%3E%3C/svg%3E");}.pdoc .alert.tip{color:#0a3622;background-color:#d1e7dd;border-color:#a3cfbb;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%230a3622%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M2%206a6%206%200%201%201%2010.174%204.31c-.203.196-.359.4-.453.619l-.762%201.769A.5.5%200%200%201%2010.5%2013a.5.5%200%200%201%200%201%20.5.5%200%200%201%200%201l-.224.447a1%201%200%200%201-.894.553H6.618a1%201%200%200%201-.894-.553L5.5%2015a.5.5%200%200%201%200-1%20.5.5%200%200%201%200-1%20.5.5%200%200%201-.46-.302l-.761-1.77a2%202%200%200%200-.453-.618A5.98%205.98%200%200%201%202%206m6-5a5%205%200%200%200-3.479%208.592c.263.254.514.564.676.941L5.83%2012h4.342l.632-1.467c.162-.377.413-.687.676-.941A5%205%200%200%200%208%201%22/%3E%3C/svg%3E");}.pdoc .alert.important{color:#055160;background-color:#cff4fc;border-color:#9eeaf9;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23055160%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M2%200a2%202%200%200%200-2%202v12a2%202%200%200%200%202%202h12a2%202%200%200%200%202-2V2a2%202%200%200%200-2-2zm6%204c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%204.995A.905.905%200%200%201%208%204m.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2%22/%3E%3C/svg%3E");}.pdoc .alert.warning{color:#664d03;background-color:#fff3cd;border-color:#ffecb5;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23664d03%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8.982%201.566a1.13%201.13%200%200%200-1.96%200L.165%2013.233c-.457.778.091%201.767.98%201.767h13.713c.889%200%201.438-.99.98-1.767L8.982%201.566zM8%205c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%205.995A.905.905%200%200%201%208%205zm.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2z%22/%3E%3C/svg%3E");}.pdoc .alert.caution{color:#842029;background-color:#f8d7da;border-color:#f5c2c7;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23842029%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M11.46.146A.5.5%200%200%200%2011.107%200H4.893a.5.5%200%200%200-.353.146L.146%204.54A.5.5%200%200%200%200%204.893v6.214a.5.5%200%200%200%20.146.353l4.394%204.394a.5.5%200%200%200%20.353.146h6.214a.5.5%200%200%200%20.353-.146l4.394-4.394a.5.5%200%200%200%20.146-.353V4.893a.5.5%200%200%200-.146-.353zM8%204c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%204.995A.905.905%200%200%201%208%204m.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2%22/%3E%3C/svg%3E");}.pdoc .alert.danger{color:#842029;background-color:#f8d7da;border-color:#f5c2c7;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23842029%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M5.52.359A.5.5%200%200%201%206%200h4a.5.5%200%200%201%20.474.658L8.694%206H12.5a.5.5%200%200%201%20.395.807l-7%209a.5.5%200%200%201-.873-.454L6.823%209.5H3.5a.5.5%200%200%201-.48-.641l2.5-8.5z%22/%3E%3C/svg%3E");}.pdoc .visually-hidden{position:absolute !important;width:1px !important;height:1px !important;padding:0 !important;margin:-1px !important;overflow:hidden !important;clip:rect(0, 0, 0, 0) !important;white-space:nowrap !important;border:0 !important;}.pdoc h1, .pdoc h2, .pdoc h3{font-weight:300;margin:.3em 0;padding:.2em 0;}.pdoc > section:not(.module-info) h1{font-size:1.5rem;font-weight:500;}.pdoc > section:not(.module-info) h2{font-size:1.4rem;font-weight:500;}.pdoc > section:not(.module-info) h3{font-size:1.3rem;font-weight:500;}.pdoc > section:not(.module-info) h4{font-size:1.2rem;}.pdoc > section:not(.module-info) h5{font-size:1.1rem;}.pdoc a{text-decoration:none;color:var(--link);}.pdoc a:hover{color:var(--link-hover);}.pdoc blockquote{margin-left:2rem;}.pdoc pre{border-top:1px solid var(--accent2);border-bottom:1px solid var(--accent2);margin-top:0;margin-bottom:1em;padding:.5rem 0 .5rem .5rem;overflow-x:auto;background-color:var(--code);}.pdoc code{color:var(--text);padding:.2em .4em;margin:0;font-size:85%;background-color:var(--accent);border-radius:6px;}.pdoc a > code{color:inherit;}.pdoc pre > code{display:inline-block;font-size:inherit;background:none;border:none;padding:0;}.pdoc > section:not(.module-info){margin-bottom:1.5rem;}.pdoc .modulename{margin-top:0;font-weight:bold;}.pdoc .modulename a{color:var(--link);transition:100ms all;}.pdoc .git-button{float:right;border:solid var(--link) 1px;}.pdoc .git-button:hover{background-color:var(--link);color:var(--pdoc-background);}.view-source-toggle-state,.view-source-toggle-state ~ .pdoc-code{display:none;}.view-source-toggle-state:checked ~ .pdoc-code{display:block;}.view-source-button{display:inline-block;float:right;font-size:.75rem;line-height:1.5rem;color:var(--muted);padding:0 .4rem 0 1.3rem;cursor:pointer;text-indent:-2px;}.view-source-button > span{visibility:hidden;}.module-info .view-source-button{float:none;display:flex;justify-content:flex-end;margin:-1.2rem .4rem -.2rem 0;}.view-source-button::before{position:absolute;content:"View Source";display:list-item;list-style-type:disclosure-closed;}.view-source-toggle-state:checked ~ .attr .view-source-button::before,.view-source-toggle-state:checked ~ .view-source-button::before{list-style-type:disclosure-open;}.pdoc .docstring{margin-bottom:1.5rem;}.pdoc section:not(.module-info) .docstring{margin-left:clamp(0rem, 5vw - 2rem, 1rem);}.pdoc .docstring .pdoc-code{margin-left:1em;margin-right:1em;}.pdoc h1:target,.pdoc h2:target,.pdoc h3:target,.pdoc h4:target,.pdoc h5:target,.pdoc h6:target,.pdoc .pdoc-code > pre > span:target{background-color:var(--active);box-shadow:-1rem 0 0 0 var(--active);}.pdoc .pdoc-code > pre > span:target{display:block;}.pdoc div:target > .attr,.pdoc section:target > .attr,.pdoc dd:target > a{background-color:var(--active);}.pdoc *{scroll-margin:2rem;}.pdoc .pdoc-code .linenos{user-select:none;}.pdoc .attr:hover{filter:contrast(0.95);}.pdoc section, .pdoc .classattr{position:relative;}.pdoc .headerlink{--width:clamp(1rem, 3vw, 2rem);position:absolute;top:0;left:calc(0rem - var(--width));transition:all 100ms ease-in-out;opacity:0;}.pdoc .headerlink::before{content:"#";display:block;text-align:center;width:var(--width);height:2.3rem;line-height:2.3rem;font-size:1.5rem;}.pdoc .attr:hover ~ .headerlink,.pdoc *:target > .headerlink,.pdoc .headerlink:hover{opacity:1;}.pdoc .attr{display:block;margin:.5rem 0 .5rem;padding:.4rem .4rem .4rem 1rem;background-color:var(--accent);overflow-x:auto;}.pdoc .classattr{margin-left:2rem;}.pdoc .decorator-deprecated{color:#842029;}.pdoc .decorator-deprecated ~ span{filter:grayscale(1) opacity(0.8);}.pdoc .name{color:var(--name);font-weight:bold;}.pdoc .def{color:var(--def);font-weight:bold;}.pdoc .signature{background-color:transparent;}.pdoc .param, .pdoc .return-annotation{white-space:pre;}.pdoc .signature.multiline .param{display:block;}.pdoc .signature.condensed .param{display:inline-block;}.pdoc .annotation{color:var(--annotation);}.pdoc .view-value-toggle-state,.pdoc .view-value-toggle-state ~ .default_value{display:none;}.pdoc .view-value-toggle-state:checked ~ .default_value{display:inherit;}.pdoc .view-value-button{font-size:.5rem;vertical-align:middle;border-style:dashed;margin-top:-0.1rem;}.pdoc .view-value-button:hover{background:white;}.pdoc .view-value-button::before{content:"show";text-align:center;width:2.2em;display:inline-block;}.pdoc .view-value-toggle-state:checked ~ .view-value-button::before{content:"hide";}.pdoc .inherited{margin-left:2rem;}.pdoc .inherited dt{font-weight:700;}.pdoc .inherited dt, .pdoc .inherited dd{display:inline;margin-left:0;margin-bottom:.5rem;}.pdoc .inherited dd:not(:last-child):after{content:", ";}.pdoc .inherited .class:before{content:"class ";}.pdoc .inherited .function a:after{content:"()";}.pdoc .search-result .docstring{overflow:auto;max-height:25vh;}.pdoc .search-result.focused > .attr{background-color:var(--active);}.pdoc .attribution{margin-top:2rem;display:block;opacity:0.5;transition:all 200ms;filter:grayscale(100%);}.pdoc .attribution:hover{opacity:1;filter:grayscale(0%);}.pdoc .attribution img{margin-left:5px;height:27px;vertical-align:bottom;width:50px;transition:all 200ms;}.pdoc table{display:block;width:max-content;max-width:100%;overflow:auto;margin-bottom:1rem;}.pdoc table th{font-weight:600;}.pdoc table th, .pdoc table td{padding:6px 13px;border:1px solid var(--accent2);}</style>
<style>/*! custom.css */</style></head>
<body>
<nav class="pdoc">
<label id="navtoggle" for="togglestate" class="pdoc-button"><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'><path stroke-linecap='round' stroke="currentColor" stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/></svg></label>
<input id="togglestate" type="checkbox" aria-hidden="true" tabindex="-1">
<div>
<h2>API Documentation</h2>
<ul class="memberlist">
<li>
<a class="function" href="#links">links</a>
</li>
<li>
<a class="function" href="#refs">refs</a>
</li>
<li>
<a class="function" href="#admonitions">admonitions</a>
</li>
<li>
<a class="function" href="#seealso">seealso</a>
</li>
<li>
<a class="function" href="#seealso_short">seealso_short</a>
</li>
<li>
<a class="function" href="#tables">tables</a>
</li>
<li>
<a class="function" href="#footnote1">footnote1</a>
</li>
<li>
<a class="function" href="#footnote2">footnote2</a>
</li>
<li>
<a class="function" href="#footnote3">footnote3</a>
</li>
<li>
<a class="function" href="#footnote4">footnote4</a>
</li>
<li>
<a class="function" href="#include">include</a>
</li>
<li>
<a class="function" href="#include_options">include_options</a>
</li>
<li>
<a class="function" href="#fields">fields</a>
</li>
<li>
<a class="function" href="#fields_text_after_param">fields_text_after_param</a>
</li>
<li>
<a class="function" href="#fields_invalid">fields_invalid</a>
</li>
<li>
<a class="function" href="#fields_exception">fields_exception</a>
</li>
</ul>
<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
alt="pdoc logo"
src="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22160%22%20viewBox%3D%220%200%20150%2080%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M132.316%2048.886c.276-4.679%202.342-6.698%204.409-7.982s4.27-1.165%206.751-1.055c1.586.07%203.044.156%204.222-.482%201.142-.619%202.026-1.932%202.162-3.739.268-3.576-1.929-5.368-5.006-5.551s-7.599.524-10.517%201.606c-4.455%201.652-8.588%206.606-9.552%208.992s-2.342%206.193-1.745%2010.873%202.664%209.221%205.878%2011.79%205.878%203.808%2010.103%204.312%203.444.229%206.062.229%205.006-2.202%204.914-4.909-2.296-5.001-4.501-4.863-3.077.505-5.281.229-7.715-2.064-7.899-9.451z%22%20fill%3D%22%23198754%22/%3E%3Ccircle%20cx%3D%22101.504%22%20cy%3D%2248.943%22%20r%3D%2214.208%22%20fill%3D%22none%22%20stroke%3D%22%23198754%22%20stroke-width%3D%229.354%22/%3E%3Cpath%20d%3D%22M87.81.002c-3.637.065-5.001.454-7.014%201.232s-3.443%201.363-6.3%204.282c-1.723%201.76-3.148%205.019-3.776%207.329-.413%201.521-.316%202.63-.316%202.63l-.195%2034.612c.065%205.774-6.755%208.305-9.612%208.37s-9.678-1.038-9.743-9.408%207.128-9.521%208.362-9.521c1.413-.13%202.526-.021%203.718-.016%202.071.009%204.157-.778%204.092-4.671s-4.157-4.736-4.157-4.736c-6.3-.843-11.43%202.206-11.43%202.206S40.917%2038.15%2041.372%2049.634%2051.568%2068.19%2061.311%2068.125s18.316-7.007%2018.445-17.193l.13-22.772c.046-2.291%202.683-3.644%204.476-4.203.745-.232%201.694-.274%201.694-.274l10.457-.13s4.871-.324%207.729-3.114%204.352-6.294%204.352-6.294.974-3.049.13-4.606-.195-1.233-2.792-3.309-8.573-4.477-8.573-4.477S91.447-.063%2087.81.002zM0%2047.169l.065%2028.417S0%2080.127%204.481%2079.997s5.072-3.866%205.049-4.152l-.113-28.482s1.624-7.656%209.937-7.721%2010.002%206.942%2010.002%208.499-.909%2010.51-9.093%2010.51c-.948%200-2.99-.567-4.145-.272-3.919%201-3.194%204.554-3.194%204.554s.065%205.061%207.404%204.996%2018.575-6.034%2018.575-19.074S26.953%2030.04%2019.549%2029.91%201.234%2035.296%200%2047.169z%22%20fill%3D%22%23198754%22/%3E%3Cg%20transform%3D%22matrix%28.325601%200%200%20.325256%20-10.32669%20-45.802786%29%22%3E%3Ccircle%20cx%3D%22297.554%22%20cy%3D%22172.286%22%20r%3D%2216.5%22%20fill%3D%22%23fff%22/%3E%3Cellipse%20cx%3D%22297.709%22%20cy%3D%22172.642%22%20rx%3D%2211.071%22%20ry%3D%2210.871%22%20fill%3D%22%23105a48%22/%3E%3Ccircle%20cx%3D%22304.104%22%20cy%3D%22167.667%22%20r%3D%224.5%22%20fill%3D%22%23fff%22/%3E%3C/g%3E%3Cpath%20d%3D%22M94.661%2017.032l.893-1.476s.99.714%201.916.925%201.575.114%202.955.114l14.565-.162c1.283-.032%203.085-.762%203.02-3.293s-.373-3.503-.373-3.503l1.283-.487s.52.503.877%201.573.309%201.995.292%202.66-.227%201.541-.227%201.541%201.564-.308%202.359-1.038.823-.779%201.489-1.508.812-.86.812-.86.552-.13.877.26.341.957.065%201.46-1.672%202.206-3.247%203.066-2.76%201.427-3.929%201.768-3.848.73-7.063.714l-10.944-.114s-2.143-.081-3.02-.373-2.241-.973-2.598-1.265z%22%20fill%3D%22%23d36d49%22/%3E%3Cg%20fill%3D%22%23105a48%22%3E%3Cellipse%20cx%3D%2293.052%22%20cy%3D%2243.567%22%20rx%3D%22.869%22%20ry%3D%221.014%22%20transform%3D%22rotate%28341.022%29%22/%3E%3Cellipse%20cx%3D%22104.3%22%20cy%3D%22-16.184%22%20rx%3D%22.865%22%20ry%3D%221.009%22%20transform%3D%22rotate%2814.786%29%22/%3E%3C/g%3E%3C/svg%3E"/>
</a>
</div>
</nav>
<main class="pdoc">
<section class="module-info">
<h1 class="modulename">
flavors_rst </h1>
<input id="mod-flavors_rst-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<label class="view-source-button" for="mod-flavors_rst-view-source"><span>View Source</span></label>
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos"> 1</span></a><span class="n">__docformat__</span> <span class="o">=</span> <span class="s2">"restructuredtext"</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a>
</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a>
</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a><span class="k">def</span><span class="w"> </span><span class="nf">links</span><span class="p">():</span>
</span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a><span class="sd"> For type hints, read `PEP 484`_.</span>
</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="sd"> See the `Python home page <http://www.python.org>`_ for info.</span>
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a>
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a><span class="sd"> .. _PEP 484:</span>
</span><span id="L-10"><a href="#L-10"><span class="linenos"> 10</span></a><span class="sd"> https://www.python.org/dev/peps/pep-0484/</span>
</span><span id="L-11"><a href="#L-11"><span class="linenos"> 11</span></a>
</span><span id="L-12"><a href="#L-12"><span class="linenos"> 12</span></a><span class="sd"> """</span>
</span><span id="L-13"><a href="#L-13"><span class="linenos"> 13</span></a>
</span><span id="L-14"><a href="#L-14"><span class="linenos"> 14</span></a>
</span><span id="L-15"><a href="#L-15"><span class="linenos"> 15</span></a><span class="k">def</span><span class="w"> </span><span class="nf">refs</span><span class="p">():</span>
</span><span id="L-16"><a href="#L-16"><span class="linenos"> 16</span></a><span class="w"> </span><span class="sd">"""Here we have refs to :py:obj:`links` and :func:`admonitions`."""</span>
</span><span id="L-17"><a href="#L-17"><span class="linenos"> 17</span></a>
</span><span id="L-18"><a href="#L-18"><span class="linenos"> 18</span></a>
</span><span id="L-19"><a href="#L-19"><span class="linenos"> 19</span></a><span class="k">def</span><span class="w"> </span><span class="nf">admonitions</span><span class="p">():</span>
</span><span id="L-20"><a href="#L-20"><span class="linenos"> 20</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-21"><a href="#L-21"><span class="linenos"> 21</span></a>
</span><span id="L-22"><a href="#L-22"><span class="linenos"> 22</span></a><span class="sd"> .. note::</span>
</span><span id="L-23"><a href="#L-23"><span class="linenos"> 23</span></a>
</span><span id="L-24"><a href="#L-24"><span class="linenos"> 24</span></a><span class="sd"> This function is not suitable for sending spam e-mails.</span>
</span><span id="L-25"><a href="#L-25"><span class="linenos"> 25</span></a>
</span><span id="L-26"><a href="#L-26"><span class="linenos"> 26</span></a><span class="sd"> .. warning::</span>
</span><span id="L-27"><a href="#L-27"><span class="linenos"> 27</span></a><span class="sd"> This function is not suitable for sending spam e-mails.</span>
</span><span id="L-28"><a href="#L-28"><span class="linenos"> 28</span></a>
</span><span id="L-29"><a href="#L-29"><span class="linenos"> 29</span></a><span class="sd"> .. danger::</span>
</span><span id="L-30"><a href="#L-30"><span class="linenos"> 30</span></a><span class="sd"> This function is not suitable for sending **spam** e-mails.</span>
</span><span id="L-31"><a href="#L-31"><span class="linenos"> 31</span></a>
</span><span id="L-32"><a href="#L-32"><span class="linenos"> 32</span></a><span class="sd"> .. warning:: Be Careful!</span>
</span><span id="L-33"><a href="#L-33"><span class="linenos"> 33</span></a><span class="sd"> This warning has both a title and content.</span>
</span><span id="L-34"><a href="#L-34"><span class="linenos"> 34</span></a>
</span><span id="L-35"><a href="#L-35"><span class="linenos"> 35</span></a><span class="sd"> .. warning:: This warning has a title only.</span>
</span><span id="L-36"><a href="#L-36"><span class="linenos"> 36</span></a>
</span><span id="L-37"><a href="#L-37"><span class="linenos"> 37</span></a><span class="sd"> .. versionadded:: 2.5</span>
</span><span id="L-38"><a href="#L-38"><span class="linenos"> 38</span></a><span class="sd"> The *spam* parameter.</span>
</span><span id="L-39"><a href="#L-39"><span class="linenos"> 39</span></a>
</span><span id="L-40"><a href="#L-40"><span class="linenos"> 40</span></a><span class="sd"> .. versionchanged:: 2.5</span>
</span><span id="L-41"><a href="#L-41"><span class="linenos"> 41</span></a><span class="sd"> The *spam* parameter.</span>
</span><span id="L-42"><a href="#L-42"><span class="linenos"> 42</span></a>
</span><span id="L-43"><a href="#L-43"><span class="linenos"> 43</span></a><span class="sd"> .. code-block::</span>
</span><span id="L-44"><a href="#L-44"><span class="linenos"> 44</span></a><span class="sd"> This is a code block.</span>
</span><span id="L-45"><a href="#L-45"><span class="linenos"> 45</span></a>
</span><span id="L-46"><a href="#L-46"><span class="linenos"> 46</span></a><span class="sd"> .. deprecated:: 3.1</span>
</span><span id="L-47"><a href="#L-47"><span class="linenos"> 47</span></a><span class="sd"> Use :func:`spam` instead.</span>
</span><span id="L-48"><a href="#L-48"><span class="linenos"> 48</span></a>
</span><span id="L-49"><a href="#L-49"><span class="linenos"> 49</span></a><span class="sd"> .. deprecated:: 3.1</span>
</span><span id="L-50"><a href="#L-50"><span class="linenos"> 50</span></a>
</span><span id="L-51"><a href="#L-51"><span class="linenos"> 51</span></a><span class="sd"> This text is not part of the deprecation notice.</span>
</span><span id="L-52"><a href="#L-52"><span class="linenos"> 52</span></a><span class="sd"> """</span>
</span><span id="L-53"><a href="#L-53"><span class="linenos"> 53</span></a>
</span><span id="L-54"><a href="#L-54"><span class="linenos"> 54</span></a>
</span><span id="L-55"><a href="#L-55"><span class="linenos"> 55</span></a><span class="k">def</span><span class="w"> </span><span class="nf">seealso</span><span class="p">():</span>
</span><span id="L-56"><a href="#L-56"><span class="linenos"> 56</span></a> <span class="c1"># this is not properly supported yet</span>
</span><span id="L-57"><a href="#L-57"><span class="linenos"> 57</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-58"><a href="#L-58"><span class="linenos"> 58</span></a><span class="sd"> .. seealso::</span>
</span><span id="L-59"><a href="#L-59"><span class="linenos"> 59</span></a>
</span><span id="L-60"><a href="#L-60"><span class="linenos"> 60</span></a><span class="sd"> Module :py:mod:`zipfile`</span>
</span><span id="L-61"><a href="#L-61"><span class="linenos"> 61</span></a><span class="sd"> Documentation of the :py:mod:`zipfile` standard module.</span>
</span><span id="L-62"><a href="#L-62"><span class="linenos"> 62</span></a>
</span><span id="L-63"><a href="#L-63"><span class="linenos"> 63</span></a><span class="sd"> `GNU tar manual, Basic Tar Format <http://link>`_</span>
</span><span id="L-64"><a href="#L-64"><span class="linenos"> 64</span></a><span class="sd"> Documentation for tar archive files, including GNU tar extensions.</span>
</span><span id="L-65"><a href="#L-65"><span class="linenos"> 65</span></a><span class="sd"> """</span>
</span><span id="L-66"><a href="#L-66"><span class="linenos"> 66</span></a>
</span><span id="L-67"><a href="#L-67"><span class="linenos"> 67</span></a>
</span><span id="L-68"><a href="#L-68"><span class="linenos"> 68</span></a><span class="k">def</span><span class="w"> </span><span class="nf">seealso_short</span><span class="p">():</span>
</span><span id="L-69"><a href="#L-69"><span class="linenos"> 69</span></a> <span class="c1"># this is not properly supported yet</span>
</span><span id="L-70"><a href="#L-70"><span class="linenos"> 70</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-71"><a href="#L-71"><span class="linenos"> 71</span></a><span class="sd"> .. seealso:: modules :py:mod:`zipfile`, :py:mod:`tarfile`</span>
</span><span id="L-72"><a href="#L-72"><span class="linenos"> 72</span></a><span class="sd"> """</span>
</span><span id="L-73"><a href="#L-73"><span class="linenos"> 73</span></a>
</span><span id="L-74"><a href="#L-74"><span class="linenos"> 74</span></a>
</span><span id="L-75"><a href="#L-75"><span class="linenos"> 75</span></a><span class="k">def</span><span class="w"> </span><span class="nf">tables</span><span class="p">():</span>
</span><span id="L-76"><a href="#L-76"><span class="linenos"> 76</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-77"><a href="#L-77"><span class="linenos"> 77</span></a><span class="sd"> | Header 1 | *Header* 2 |</span>
</span><span id="L-78"><a href="#L-78"><span class="linenos"> 78</span></a><span class="sd"> | -------- | -------- |</span>
</span><span id="L-79"><a href="#L-79"><span class="linenos"> 79</span></a><span class="sd"> | `Cell 1` | [Cell 2](http://example.com) link |</span>
</span><span id="L-80"><a href="#L-80"><span class="linenos"> 80</span></a><span class="sd"> | Cell 3 | **Cell 4** |</span>
</span><span id="L-81"><a href="#L-81"><span class="linenos"> 81</span></a><span class="sd"> """</span>
</span><span id="L-82"><a href="#L-82"><span class="linenos"> 82</span></a>
</span><span id="L-83"><a href="#L-83"><span class="linenos"> 83</span></a>
</span><span id="L-84"><a href="#L-84"><span class="linenos"> 84</span></a><span class="k">def</span><span class="w"> </span><span class="nf">footnote1</span><span class="p">():</span>
</span><span id="L-85"><a href="#L-85"><span class="linenos"> 85</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-86"><a href="#L-86"><span class="linenos"> 86</span></a><span class="sd"> Cite the relevant literature, e.g. [1]_. You may also cite these</span>
</span><span id="L-87"><a href="#L-87"><span class="linenos"> 87</span></a><span class="sd"> references in the notes section above.</span>
</span><span id="L-88"><a href="#L-88"><span class="linenos"> 88</span></a>
</span><span id="L-89"><a href="#L-89"><span class="linenos"> 89</span></a><span class="sd"> .. [1] O. McNoleg, "The integration of GIS, remote sensing,</span>
</span><span id="L-90"><a href="#L-90"><span class="linenos"> 90</span></a><span class="sd"> expert systems and adaptive co-kriging for environmental habitat</span>
</span><span id="L-91"><a href="#L-91"><span class="linenos"> 91</span></a><span class="sd"> modelling of the Highland Haggis using object-oriented, fuzzy-logic</span>
</span><span id="L-92"><a href="#L-92"><span class="linenos"> 92</span></a><span class="sd"> and neural-network techniques," Computers & Geosciences, vol. 22,</span>
</span><span id="L-93"><a href="#L-93"><span class="linenos"> 93</span></a><span class="sd"> pp. 585-588, 1996.</span>
</span><span id="L-94"><a href="#L-94"><span class="linenos"> 94</span></a><span class="sd"> """</span>
</span><span id="L-95"><a href="#L-95"><span class="linenos"> 95</span></a>
</span><span id="L-96"><a href="#L-96"><span class="linenos"> 96</span></a>
</span><span id="L-97"><a href="#L-97"><span class="linenos"> 97</span></a><span class="k">def</span><span class="w"> </span><span class="nf">footnote2</span><span class="p">():</span>
</span><span id="L-98"><a href="#L-98"><span class="linenos"> 98</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-99"><a href="#L-99"><span class="linenos"> 99</span></a><span class="sd"> Autonumbered footnotes are</span>
</span><span id="L-100"><a href="#L-100"><span class="linenos">100</span></a><span class="sd"> possible, like using [#]_ and [#]_.</span>
</span><span id="L-101"><a href="#L-101"><span class="linenos">101</span></a>
</span><span id="L-102"><a href="#L-102"><span class="linenos">102</span></a><span class="sd"> .. [#] This is the first one.</span>
</span><span id="L-103"><a href="#L-103"><span class="linenos">103</span></a><span class="sd"> .. [#] This is the second one.</span>
</span><span id="L-104"><a href="#L-104"><span class="linenos">104</span></a>
</span><span id="L-105"><a href="#L-105"><span class="linenos">105</span></a><span class="sd"> They may be assigned 'autonumber</span>
</span><span id="L-106"><a href="#L-106"><span class="linenos">106</span></a><span class="sd"> labels' - for instance,</span>
</span><span id="L-107"><a href="#L-107"><span class="linenos">107</span></a><span class="sd"> [#fourth]_ and [#third]_.</span>
</span><span id="L-108"><a href="#L-108"><span class="linenos">108</span></a>
</span><span id="L-109"><a href="#L-109"><span class="linenos">109</span></a><span class="sd"> .. [#third] a.k.a. third_</span>
</span><span id="L-110"><a href="#L-110"><span class="linenos">110</span></a>
</span><span id="L-111"><a href="#L-111"><span class="linenos">111</span></a><span class="sd"> .. [#fourth] a.k.a. fourth_</span>
</span><span id="L-112"><a href="#L-112"><span class="linenos">112</span></a><span class="sd"> """</span>
</span><span id="L-113"><a href="#L-113"><span class="linenos">113</span></a>
</span><span id="L-114"><a href="#L-114"><span class="linenos">114</span></a>
</span><span id="L-115"><a href="#L-115"><span class="linenos">115</span></a><span class="k">def</span><span class="w"> </span><span class="nf">footnote3</span><span class="p">():</span>
</span><span id="L-116"><a href="#L-116"><span class="linenos">116</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-117"><a href="#L-117"><span class="linenos">117</span></a><span class="sd"> Auto-symbol footnotes are also</span>
</span><span id="L-118"><a href="#L-118"><span class="linenos">118</span></a><span class="sd"> possible, like this: [*]_ and [*]_.</span>
</span><span id="L-119"><a href="#L-119"><span class="linenos">119</span></a>
</span><span id="L-120"><a href="#L-120"><span class="linenos">120</span></a><span class="sd"> .. [*] This is the first one.</span>
</span><span id="L-121"><a href="#L-121"><span class="linenos">121</span></a><span class="sd"> .. [*] This is the second one.</span>
</span><span id="L-122"><a href="#L-122"><span class="linenos">122</span></a><span class="sd"> """</span>
</span><span id="L-123"><a href="#L-123"><span class="linenos">123</span></a>
</span><span id="L-124"><a href="#L-124"><span class="linenos">124</span></a>
</span><span id="L-125"><a href="#L-125"><span class="linenos">125</span></a><span class="k">def</span><span class="w"> </span><span class="nf">footnote4</span><span class="p">():</span>
</span><span id="L-126"><a href="#L-126"><span class="linenos">126</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-127"><a href="#L-127"><span class="linenos">127</span></a><span class="sd"> There is no footnote for this reference [#]_.</span>
</span><span id="L-128"><a href="#L-128"><span class="linenos">128</span></a><span class="sd"> """</span>
</span><span id="L-129"><a href="#L-129"><span class="linenos">129</span></a>
</span><span id="L-130"><a href="#L-130"><span class="linenos">130</span></a>
</span><span id="L-131"><a href="#L-131"><span class="linenos">131</span></a><span class="k">def</span><span class="w"> </span><span class="nf">include</span><span class="p">():</span>
</span><span id="L-132"><a href="#L-132"><span class="linenos">132</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-133"><a href="#L-133"><span class="linenos">133</span></a><span class="sd"> Included from another file:</span>
</span><span id="L-134"><a href="#L-134"><span class="linenos">134</span></a>
</span><span id="L-135"><a href="#L-135"><span class="linenos">135</span></a><span class="sd"> .. include:: flavors_rst_include/include.rst</span>
</span><span id="L-136"><a href="#L-136"><span class="linenos">136</span></a><span class="sd"> """</span>
</span><span id="L-137"><a href="#L-137"><span class="linenos">137</span></a>
</span><span id="L-138"><a href="#L-138"><span class="linenos">138</span></a>
</span><span id="L-139"><a href="#L-139"><span class="linenos">139</span></a><span class="k">def</span><span class="w"> </span><span class="nf">include_options</span><span class="p">():</span>
</span><span id="L-140"><a href="#L-140"><span class="linenos">140</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-141"><a href="#L-141"><span class="linenos">141</span></a><span class="sd"> Included from another file:</span>
</span><span id="L-142"><a href="#L-142"><span class="linenos">142</span></a>
</span><span id="L-143"><a href="#L-143"><span class="linenos">143</span></a><span class="sd"> .. include:: flavors_rst_include/include_2.md</span>
</span><span id="L-144"><a href="#L-144"><span class="linenos">144</span></a><span class="sd"> :start-line: 2</span>
</span><span id="L-145"><a href="#L-145"><span class="linenos">145</span></a><span class="sd"> :end-line: 5</span>
</span><span id="L-146"><a href="#L-146"><span class="linenos">146</span></a>
</span><span id="L-147"><a href="#L-147"><span class="linenos">147</span></a>
</span><span id="L-148"><a href="#L-148"><span class="linenos">148</span></a><span class="sd"> Also included:</span>
</span><span id="L-149"><a href="#L-149"><span class="linenos">149</span></a>
</span><span id="L-150"><a href="#L-150"><span class="linenos">150</span></a><span class="sd"> .. include:: flavors_rst_include/include_2.md</span>
</span><span id="L-151"><a href="#L-151"><span class="linenos">151</span></a><span class="sd"> :start-after: <!-- start here --></span>
</span><span id="L-152"><a href="#L-152"><span class="linenos">152</span></a><span class="sd"> :end-before: <!-- end here --></span>
</span><span id="L-153"><a href="#L-153"><span class="linenos">153</span></a><span class="sd"> """</span>
</span><span id="L-154"><a href="#L-154"><span class="linenos">154</span></a>
</span><span id="L-155"><a href="#L-155"><span class="linenos">155</span></a>
</span><span id="L-156"><a href="#L-156"><span class="linenos">156</span></a><span class="k">def</span><span class="w"> </span><span class="nf">fields</span><span class="p">(</span><span class="n">foo</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"foo"</span><span class="p">,</span> <span class="n">bar</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
</span><span id="L-157"><a href="#L-157"><span class="linenos">157</span></a><span class="w"> </span><span class="sd">"""This method has field descriptions.</span>
</span><span id="L-158"><a href="#L-158"><span class="linenos">158</span></a>
</span><span id="L-159"><a href="#L-159"><span class="linenos">159</span></a><span class="sd"> :param foo: A string,</span>
</span><span id="L-160"><a href="#L-160"><span class="linenos">160</span></a><span class="sd"> defaults to None</span>
</span><span id="L-161"><a href="#L-161"><span class="linenos">161</span></a><span class="sd"> :type foo: string, optional</span>
</span><span id="L-162"><a href="#L-162"><span class="linenos">162</span></a><span class="sd"> :param bar: Another</span>
</span><span id="L-163"><a href="#L-163"><span class="linenos">163</span></a><span class="sd"> boolean.</span>
</span><span id="L-164"><a href="#L-164"><span class="linenos">164</span></a><span class="sd"> :return: Another string,</span>
</span><span id="L-165"><a href="#L-165"><span class="linenos">165</span></a><span class="sd"> or maybe `None`.</span>
</span><span id="L-166"><a href="#L-166"><span class="linenos">166</span></a><span class="sd"> :rtype: A string.</span>
</span><span id="L-167"><a href="#L-167"><span class="linenos">167</span></a><span class="sd"> """</span>
</span><span id="L-168"><a href="#L-168"><span class="linenos">168</span></a> <span class="k">raise</span> <span class="ne">NotImplementedError</span>
</span><span id="L-169"><a href="#L-169"><span class="linenos">169</span></a>
</span><span id="L-170"><a href="#L-170"><span class="linenos">170</span></a>
</span><span id="L-171"><a href="#L-171"><span class="linenos">171</span></a><span class="k">def</span><span class="w"> </span><span class="nf">fields_text_after_param</span><span class="p">(</span><span class="n">foo</span><span class="p">):</span>
</span><span id="L-172"><a href="#L-172"><span class="linenos">172</span></a><span class="w"> </span><span class="sd">"""This method has text after the `:param` fields.</span>
</span><span id="L-173"><a href="#L-173"><span class="linenos">173</span></a>
</span><span id="L-174"><a href="#L-174"><span class="linenos">174</span></a><span class="sd"> :param foo: Some text.</span>
</span><span id="L-175"><a href="#L-175"><span class="linenos">175</span></a>
</span><span id="L-176"><a href="#L-176"><span class="linenos">176</span></a><span class="sd"> Here's some more text.</span>
</span><span id="L-177"><a href="#L-177"><span class="linenos">177</span></a><span class="sd"> """</span>
</span><span id="L-178"><a href="#L-178"><span class="linenos">178</span></a>
</span><span id="L-179"><a href="#L-179"><span class="linenos">179</span></a>
</span><span id="L-180"><a href="#L-180"><span class="linenos">180</span></a><span class="k">def</span><span class="w"> </span><span class="nf">fields_invalid</span><span class="p">(</span><span class="n">foo</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"foo"</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
</span><span id="L-181"><a href="#L-181"><span class="linenos">181</span></a><span class="w"> </span><span class="sd">"""This method has invalid `:param` definitions.</span>
</span><span id="L-182"><a href="#L-182"><span class="linenos">182</span></a>
</span><span id="L-183"><a href="#L-183"><span class="linenos">183</span></a><span class="sd"> :param: What is this for?</span>
</span><span id="L-184"><a href="#L-184"><span class="linenos">184</span></a>
</span><span id="L-185"><a href="#L-185"><span class="linenos">185</span></a><span class="sd"> :unknown: This is an unknown field name.</span>
</span><span id="L-186"><a href="#L-186"><span class="linenos">186</span></a><span class="sd"> """</span>
</span><span id="L-187"><a href="#L-187"><span class="linenos">187</span></a> <span class="k">raise</span> <span class="ne">NotImplementedError</span>
</span><span id="L-188"><a href="#L-188"><span class="linenos">188</span></a>
</span><span id="L-189"><a href="#L-189"><span class="linenos">189</span></a>
</span><span id="L-190"><a href="#L-190"><span class="linenos">190</span></a><span class="k">def</span><span class="w"> </span><span class="nf">fields_exception</span><span class="p">():</span>
</span><span id="L-191"><a href="#L-191"><span class="linenos">191</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="L-192"><a href="#L-192"><span class="linenos">192</span></a><span class="sd"> :raises RuntimeError: Some multi-line</span>
</span><span id="L-193"><a href="#L-193"><span class="linenos">193</span></a><span class="sd"> exception description.</span>
</span><span id="L-194"><a href="#L-194"><span class="linenos">194</span></a><span class="sd"> """</span>
</span></pre></div>
</section>
<section id="links">
<input id="links-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">links</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="links-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#links"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="links-5"><a href="#links-5"><span class="linenos"> 5</span></a><span class="k">def</span><span class="w"> </span><span class="nf">links</span><span class="p">():</span>
</span><span id="links-6"><a href="#links-6"><span class="linenos"> 6</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="links-7"><a href="#links-7"><span class="linenos"> 7</span></a><span class="sd"> For type hints, read `PEP 484`_.</span>
</span><span id="links-8"><a href="#links-8"><span class="linenos"> 8</span></a><span class="sd"> See the `Python home page <http://www.python.org>`_ for info.</span>
</span><span id="links-9"><a href="#links-9"><span class="linenos"> 9</span></a>
</span><span id="links-10"><a href="#links-10"><span class="linenos">10</span></a><span class="sd"> .. _PEP 484:</span>
</span><span id="links-11"><a href="#links-11"><span class="linenos">11</span></a><span class="sd"> https://www.python.org/dev/peps/pep-0484/</span>
</span><span id="links-12"><a href="#links-12"><span class="linenos">12</span></a>
</span><span id="links-13"><a href="#links-13"><span class="linenos">13</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>For type hints, read <a href="https://www.python.org/dev/peps/pep-0484/">PEP 484</a>.
See the <a href="http://www.python.org">Python home page </a> for info.</p>
</div>
</section>
<section id="refs">
<input id="refs-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">refs</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="refs-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#refs"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="refs-16"><a href="#refs-16"><span class="linenos">16</span></a><span class="k">def</span><span class="w"> </span><span class="nf">refs</span><span class="p">():</span>
</span><span id="refs-17"><a href="#refs-17"><span class="linenos">17</span></a><span class="w"> </span><span class="sd">"""Here we have refs to :py:obj:`links` and :func:`admonitions`."""</span>
</span></pre></div>
<div class="docstring"><p>Here we have refs to <code><a href="#links">links</a></code> and <code><a href="#admonitions">admonitions()</a></code>.</p>
</div>
</section>
<section id="admonitions">
<input id="admonitions-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">admonitions</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="admonitions-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#admonitions"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="admonitions-20"><a href="#admonitions-20"><span class="linenos">20</span></a><span class="k">def</span><span class="w"> </span><span class="nf">admonitions</span><span class="p">():</span>
</span><span id="admonitions-21"><a href="#admonitions-21"><span class="linenos">21</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="admonitions-22"><a href="#admonitions-22"><span class="linenos">22</span></a>
</span><span id="admonitions-23"><a href="#admonitions-23"><span class="linenos">23</span></a><span class="sd"> .. note::</span>
</span><span id="admonitions-24"><a href="#admonitions-24"><span class="linenos">24</span></a>
</span><span id="admonitions-25"><a href="#admonitions-25"><span class="linenos">25</span></a><span class="sd"> This function is not suitable for sending spam e-mails.</span>
</span><span id="admonitions-26"><a href="#admonitions-26"><span class="linenos">26</span></a>
</span><span id="admonitions-27"><a href="#admonitions-27"><span class="linenos">27</span></a><span class="sd"> .. warning::</span>
</span><span id="admonitions-28"><a href="#admonitions-28"><span class="linenos">28</span></a><span class="sd"> This function is not suitable for sending spam e-mails.</span>
</span><span id="admonitions-29"><a href="#admonitions-29"><span class="linenos">29</span></a>
</span><span id="admonitions-30"><a href="#admonitions-30"><span class="linenos">30</span></a><span class="sd"> .. danger::</span>
</span><span id="admonitions-31"><a href="#admonitions-31"><span class="linenos">31</span></a><span class="sd"> This function is not suitable for sending **spam** e-mails.</span>
</span><span id="admonitions-32"><a href="#admonitions-32"><span class="linenos">32</span></a>
</span><span id="admonitions-33"><a href="#admonitions-33"><span class="linenos">33</span></a><span class="sd"> .. warning:: Be Careful!</span>
</span><span id="admonitions-34"><a href="#admonitions-34"><span class="linenos">34</span></a><span class="sd"> This warning has both a title and content.</span>
</span><span id="admonitions-35"><a href="#admonitions-35"><span class="linenos">35</span></a>
</span><span id="admonitions-36"><a href="#admonitions-36"><span class="linenos">36</span></a><span class="sd"> .. warning:: This warning has a title only.</span>
</span><span id="admonitions-37"><a href="#admonitions-37"><span class="linenos">37</span></a>
</span><span id="admonitions-38"><a href="#admonitions-38"><span class="linenos">38</span></a><span class="sd"> .. versionadded:: 2.5</span>
</span><span id="admonitions-39"><a href="#admonitions-39"><span class="linenos">39</span></a><span class="sd"> The *spam* parameter.</span>
</span><span id="admonitions-40"><a href="#admonitions-40"><span class="linenos">40</span></a>
</span><span id="admonitions-41"><a href="#admonitions-41"><span class="linenos">41</span></a><span class="sd"> .. versionchanged:: 2.5</span>
</span><span id="admonitions-42"><a href="#admonitions-42"><span class="linenos">42</span></a><span class="sd"> The *spam* parameter.</span>
</span><span id="admonitions-43"><a href="#admonitions-43"><span class="linenos">43</span></a>
</span><span id="admonitions-44"><a href="#admonitions-44"><span class="linenos">44</span></a><span class="sd"> .. code-block::</span>
</span><span id="admonitions-45"><a href="#admonitions-45"><span class="linenos">45</span></a><span class="sd"> This is a code block.</span>
</span><span id="admonitions-46"><a href="#admonitions-46"><span class="linenos">46</span></a>
</span><span id="admonitions-47"><a href="#admonitions-47"><span class="linenos">47</span></a><span class="sd"> .. deprecated:: 3.1</span>
</span><span id="admonitions-48"><a href="#admonitions-48"><span class="linenos">48</span></a><span class="sd"> Use :func:`spam` instead.</span>
</span><span id="admonitions-49"><a href="#admonitions-49"><span class="linenos">49</span></a>
</span><span id="admonitions-50"><a href="#admonitions-50"><span class="linenos">50</span></a><span class="sd"> .. deprecated:: 3.1</span>
</span><span id="admonitions-51"><a href="#admonitions-51"><span class="linenos">51</span></a>
</span><span id="admonitions-52"><a href="#admonitions-52"><span class="linenos">52</span></a><span class="sd"> This text is not part of the deprecation notice.</span>
</span><span id="admonitions-53"><a href="#admonitions-53"><span class="linenos">53</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><div class="alert note">
<p>This function is not suitable for sending spam e-mails.</p>
</div>
<div class="alert warning">
<p>This function is not suitable for sending spam e-mails.</p>
</div>
<div class="alert danger">
<p>This function is not suitable for sending <strong>spam</strong> e-mails.</p>
</div>
<div class="alert warning">
<h6 id="be-careful">Be Careful!</h6>
<p>This warning has both a title and content.</p>
</div>
<div class="alert warning">
<h6 id="this-warning-has-a-title-only">This warning has a title only.</h6>
</div>
<p><em>New in version 2.5:</em>
The <em>spam</em> parameter.</p>
<p><em>Changed in version 2.5:</em>
The <em>spam</em> parameter.</p>
<pre><code>This is a code block.
</code></pre>
<p><em>Deprecated since version 3.1:</em>
Use <code>spam()</code> instead.</p>
<p><em>Deprecated since version 3.1.</em></p>
<p>This text is not part of the deprecation notice.</p>
</div>
</section>
<section id="seealso">
<input id="seealso-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">seealso</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="seealso-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#seealso"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="seealso-56"><a href="#seealso-56"><span class="linenos">56</span></a><span class="k">def</span><span class="w"> </span><span class="nf">seealso</span><span class="p">():</span>
</span><span id="seealso-57"><a href="#seealso-57"><span class="linenos">57</span></a> <span class="c1"># this is not properly supported yet</span>
</span><span id="seealso-58"><a href="#seealso-58"><span class="linenos">58</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="seealso-59"><a href="#seealso-59"><span class="linenos">59</span></a><span class="sd"> .. seealso::</span>
</span><span id="seealso-60"><a href="#seealso-60"><span class="linenos">60</span></a>
</span><span id="seealso-61"><a href="#seealso-61"><span class="linenos">61</span></a><span class="sd"> Module :py:mod:`zipfile`</span>
</span><span id="seealso-62"><a href="#seealso-62"><span class="linenos">62</span></a><span class="sd"> Documentation of the :py:mod:`zipfile` standard module.</span>
</span><span id="seealso-63"><a href="#seealso-63"><span class="linenos">63</span></a>
</span><span id="seealso-64"><a href="#seealso-64"><span class="linenos">64</span></a><span class="sd"> `GNU tar manual, Basic Tar Format <http://link>`_</span>
</span><span id="seealso-65"><a href="#seealso-65"><span class="linenos">65</span></a><span class="sd"> Documentation for tar archive files, including GNU tar extensions.</span>
</span><span id="seealso-66"><a href="#seealso-66"><span class="linenos">66</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p><em>seealso:</em>
Module <code>zipfile</code>
Documentation of the <code>zipfile</code> standard module.</p>
<p><a href="http://link">GNU tar manual, Basic Tar Format </a>
Documentation for tar archive files, including GNU tar extensions.</p>
</div>
</section>
<section id="seealso_short">
<input id="seealso_short-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">seealso_short</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="seealso_short-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#seealso_short"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="seealso_short-69"><a href="#seealso_short-69"><span class="linenos">69</span></a><span class="k">def</span><span class="w"> </span><span class="nf">seealso_short</span><span class="p">():</span>
</span><span id="seealso_short-70"><a href="#seealso_short-70"><span class="linenos">70</span></a> <span class="c1"># this is not properly supported yet</span>
</span><span id="seealso_short-71"><a href="#seealso_short-71"><span class="linenos">71</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="seealso_short-72"><a href="#seealso_short-72"><span class="linenos">72</span></a><span class="sd"> .. seealso:: modules :py:mod:`zipfile`, :py:mod:`tarfile`</span>
</span><span id="seealso_short-73"><a href="#seealso_short-73"><span class="linenos">73</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p><em>seealso modules <code>zipfile</code>, <code>tarfile</code>.</em></p>
</div>
</section>
<section id="tables">
<input id="tables-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">tables</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="tables-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#tables"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="tables-76"><a href="#tables-76"><span class="linenos">76</span></a><span class="k">def</span><span class="w"> </span><span class="nf">tables</span><span class="p">():</span>
</span><span id="tables-77"><a href="#tables-77"><span class="linenos">77</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="tables-78"><a href="#tables-78"><span class="linenos">78</span></a><span class="sd"> | Header 1 | *Header* 2 |</span>
</span><span id="tables-79"><a href="#tables-79"><span class="linenos">79</span></a><span class="sd"> | -------- | -------- |</span>
</span><span id="tables-80"><a href="#tables-80"><span class="linenos">80</span></a><span class="sd"> | `Cell 1` | [Cell 2](http://example.com) link |</span>
</span><span id="tables-81"><a href="#tables-81"><span class="linenos">81</span></a><span class="sd"> | Cell 3 | **Cell 4** |</span>
</span><span id="tables-82"><a href="#tables-82"><span class="linenos">82</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><table>
<thead>
<tr>
<th>Header 1</th>
<th><em>Header</em> 2</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Cell 1</code></td>
<td><a href="http://example.com">Cell 2</a> link</td>
</tr>
<tr>
<td>Cell 3</td>
<td><strong>Cell 4</strong></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="footnote1">
<input id="footnote1-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">footnote1</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="footnote1-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#footnote1"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="footnote1-85"><a href="#footnote1-85"><span class="linenos">85</span></a><span class="k">def</span><span class="w"> </span><span class="nf">footnote1</span><span class="p">():</span>
</span><span id="footnote1-86"><a href="#footnote1-86"><span class="linenos">86</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="footnote1-87"><a href="#footnote1-87"><span class="linenos">87</span></a><span class="sd"> Cite the relevant literature, e.g. [1]_. You may also cite these</span>
</span><span id="footnote1-88"><a href="#footnote1-88"><span class="linenos">88</span></a><span class="sd"> references in the notes section above.</span>
</span><span id="footnote1-89"><a href="#footnote1-89"><span class="linenos">89</span></a>
</span><span id="footnote1-90"><a href="#footnote1-90"><span class="linenos">90</span></a><span class="sd"> .. [1] O. McNoleg, "The integration of GIS, remote sensing,</span>
</span><span id="footnote1-91"><a href="#footnote1-91"><span class="linenos">91</span></a><span class="sd"> expert systems and adaptive co-kriging for environmental habitat</span>
</span><span id="footnote1-92"><a href="#footnote1-92"><span class="linenos">92</span></a><span class="sd"> modelling of the Highland Haggis using object-oriented, fuzzy-logic</span>
</span><span id="footnote1-93"><a href="#footnote1-93"><span class="linenos">93</span></a><span class="sd"> and neural-network techniques," Computers & Geosciences, vol. 22,</span>
</span><span id="footnote1-94"><a href="#footnote1-94"><span class="linenos">94</span></a><span class="sd"> pp. 585-588, 1996.</span>
</span><span id="footnote1-95"><a href="#footnote1-95"><span class="linenos">95</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Cite the relevant literature, e.g. <sup class="footnote-ref" id="fnref-1"><a href="#fn-1">1</a></sup>. You may also cite these
references in the notes section above.</p>
<div class="footnotes">
<hr />
<ol>
<li id="fn-1">
<p>O. McNoleg, "The integration of GIS, remote sensing,
expert systems and adaptive co-kriging for environmental habitat
modelling of the Highland Haggis using object-oriented, fuzzy-logic
and neural-network techniques," Computers & Geosciences, vol. 22,
pp. 585-588, 1996. <a href="#fnref-1" class="footnoteBackLink" title="Jump back to footnote 1 in the text.">↩</a></p>
</li>
</ol>
</div>
</div>
</section>
<section id="footnote2">
<input id="footnote2-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">footnote2</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="footnote2-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#footnote2"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="footnote2-98"><a href="#footnote2-98"><span class="linenos"> 98</span></a><span class="k">def</span><span class="w"> </span><span class="nf">footnote2</span><span class="p">():</span>
</span><span id="footnote2-99"><a href="#footnote2-99"><span class="linenos"> 99</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="footnote2-100"><a href="#footnote2-100"><span class="linenos">100</span></a><span class="sd"> Autonumbered footnotes are</span>
</span><span id="footnote2-101"><a href="#footnote2-101"><span class="linenos">101</span></a><span class="sd"> possible, like using [#]_ and [#]_.</span>
</span><span id="footnote2-102"><a href="#footnote2-102"><span class="linenos">102</span></a>
</span><span id="footnote2-103"><a href="#footnote2-103"><span class="linenos">103</span></a><span class="sd"> .. [#] This is the first one.</span>
</span><span id="footnote2-104"><a href="#footnote2-104"><span class="linenos">104</span></a><span class="sd"> .. [#] This is the second one.</span>
</span><span id="footnote2-105"><a href="#footnote2-105"><span class="linenos">105</span></a>
</span><span id="footnote2-106"><a href="#footnote2-106"><span class="linenos">106</span></a><span class="sd"> They may be assigned 'autonumber</span>
</span><span id="footnote2-107"><a href="#footnote2-107"><span class="linenos">107</span></a><span class="sd"> labels' - for instance,</span>
</span><span id="footnote2-108"><a href="#footnote2-108"><span class="linenos">108</span></a><span class="sd"> [#fourth]_ and [#third]_.</span>
</span><span id="footnote2-109"><a href="#footnote2-109"><span class="linenos">109</span></a>
</span><span id="footnote2-110"><a href="#footnote2-110"><span class="linenos">110</span></a><span class="sd"> .. [#third] a.k.a. third_</span>
</span><span id="footnote2-111"><a href="#footnote2-111"><span class="linenos">111</span></a>
</span><span id="footnote2-112"><a href="#footnote2-112"><span class="linenos">112</span></a><span class="sd"> .. [#fourth] a.k.a. fourth_</span>
</span><span id="footnote2-113"><a href="#footnote2-113"><span class="linenos">113</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Autonumbered footnotes are
possible, like using <sup class="footnote-ref" id="fnref-fn-1"><a href="#fn-fn-1">1</a></sup> and <sup class="footnote-ref" id="fnref-fn-2"><a href="#fn-fn-2">2</a></sup>.</p>
<p>They may be assigned 'autonumber
labels' - for instance,
<sup class="footnote-ref" id="fnref-fourth"><a href="#fn-fourth">3</a></sup> and <sup class="footnote-ref" id="fnref-third"><a href="#fn-third">4</a></sup>.</p>
<div class="footnotes">
<hr />
<ol>
<li id="fn-fn-1">
<p>This is the first one. <a href="#fnref-fn-1" class="footnoteBackLink" title="Jump back to footnote 1 in the text.">↩</a></p>
</li>
<li id="fn-fn-2">
<p>This is the second one. <a href="#fnref-fn-2" class="footnoteBackLink" title="Jump back to footnote 2 in the text.">↩</a></p>
</li>
<li id="fn-third">
<p>a.k.a. third_ <a href="#fnref-third" class="footnoteBackLink" title="Jump back to footnote 3 in the text.">↩</a></p>
</li>
<li id="fn-fourth">
<p>a.k.a. fourth_ <a href="#fnref-fourth" class="footnoteBackLink" title="Jump back to footnote 4 in the text.">↩</a></p>
</li>
</ol>
</div>
</div>
</section>
<section id="footnote3">
<input id="footnote3-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">footnote3</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="footnote3-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#footnote3"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="footnote3-116"><a href="#footnote3-116"><span class="linenos">116</span></a><span class="k">def</span><span class="w"> </span><span class="nf">footnote3</span><span class="p">():</span>
</span><span id="footnote3-117"><a href="#footnote3-117"><span class="linenos">117</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="footnote3-118"><a href="#footnote3-118"><span class="linenos">118</span></a><span class="sd"> Auto-symbol footnotes are also</span>
</span><span id="footnote3-119"><a href="#footnote3-119"><span class="linenos">119</span></a><span class="sd"> possible, like this: [*]_ and [*]_.</span>
</span><span id="footnote3-120"><a href="#footnote3-120"><span class="linenos">120</span></a>
</span><span id="footnote3-121"><a href="#footnote3-121"><span class="linenos">121</span></a><span class="sd"> .. [*] This is the first one.</span>
</span><span id="footnote3-122"><a href="#footnote3-122"><span class="linenos">122</span></a><span class="sd"> .. [*] This is the second one.</span>
</span><span id="footnote3-123"><a href="#footnote3-123"><span class="linenos">123</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Auto-symbol footnotes are also
possible, like this: <sup class="footnote-ref" id="fnref-fn-1"><a href="#fn-fn-1">1</a></sup> and <sup class="footnote-ref" id="fnref-fn-2"><a href="#fn-fn-2">2</a></sup>.</p>
<div class="footnotes">
<hr />
<ol>
<li id="fn-fn-1">
<p>This is the first one. <a href="#fnref-fn-1" class="footnoteBackLink" title="Jump back to footnote 1 in the text.">↩</a></p>
</li>
<li id="fn-fn-2">
<p>This is the second one. <a href="#fnref-fn-2" class="footnoteBackLink" title="Jump back to footnote 2 in the text.">↩</a></p>
</li>
</ol>
</div>
</div>
</section>
<section id="footnote4">
<input id="footnote4-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">footnote4</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="footnote4-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#footnote4"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="footnote4-126"><a href="#footnote4-126"><span class="linenos">126</span></a><span class="k">def</span><span class="w"> </span><span class="nf">footnote4</span><span class="p">():</span>
</span><span id="footnote4-127"><a href="#footnote4-127"><span class="linenos">127</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="footnote4-128"><a href="#footnote4-128"><span class="linenos">128</span></a><span class="sd"> There is no footnote for this reference [#]_.</span>
</span><span id="footnote4-129"><a href="#footnote4-129"><span class="linenos">129</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>There is no footnote for this reference [#]_.</p>
</div>
</section>
<section id="include">
<input id="include-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">include</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="include-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#include"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="include-132"><a href="#include-132"><span class="linenos">132</span></a><span class="k">def</span><span class="w"> </span><span class="nf">include</span><span class="p">():</span>
</span><span id="include-133"><a href="#include-133"><span class="linenos">133</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="include-134"><a href="#include-134"><span class="linenos">134</span></a><span class="sd"> Included from another file:</span>
</span><span id="include-135"><a href="#include-135"><span class="linenos">135</span></a>
</span><span id="include-136"><a href="#include-136"><span class="linenos">136</span></a><span class="sd"> .. include:: flavors_rst_include/include.rst</span>
</span><span id="include-137"><a href="#include-137"><span class="linenos">137</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Included from another file:</p>
<p>Hello</p>
<p><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAACgCAYAAAC2eFFiAAAACXBIWXMAAB2HAAAdhwGP5fFlAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAIABJREFUeJztnXt80+X1xz/nSdqUFpSbtEm5CIJX1E2cd7d52xQnOmgjoOKcm27+BIc6mnpZ7VSaAl7ZdLI55w00Kerw7hR0TpF5n3hBUURoUm4FubVpkuf8/mgFSps0l/NNUnjer5evl0m+33NOQ3LyPOc5F2JmGAy5RsmssQNsYXWCBg1X4GFMdACAfsTcWxP1IKAHgD4AtgMIAfwtoOrBeiWIVhLhf6Rt79W3HLKcq6p0dv8agxRkHJYhVyiZMe44xep8MJ0O8GEASEDsFgAfAHifmd+zk3pjlce3XECuIQsYh2XIKoNnTHCFdeRSAJMIGJ4htasBXkRMizTZFwU9877OkF5DmhiHZcgKrtpxPwSr3wE4B4A9y+YsI+AZzfT3YKXvkyzbYoiDcViGjDJoetkRUaVqAB6dbVs6g4gWAfqOQPPhz5rYV+5hHJYhI4ysdudvdPB0BqYCUNm2JwGWAXS7zYGHV031NWXbGEMrxmEZLKfkFvdQZePHQDgm27akwDoQ7g41O+7eUPXI5mwbs7djHJbBUpw1ZaMV0VwG9s22LWmygYhmhZvxp7VVvq3ZNmZvxTgsg2WUet3nA/wwA3nZtkWQ9QTMQig0u75qwfZsG7O3YRyWwRJcNWW/BtG9AGwS8hQR9ivqDWevfrArG9ZsbUTD1o0IRyMS4lOhgZhuCLQc9oAJzmcO47AM4ji95dcQMBMCiZ9HlAzDRd87A2eMOBoDinq3e21bSzMWffUB6j5+DS998U66qlKCgCWs+MrAtLrsGLCXYRyWQRRXbfnlYPwlXTl9e/TC9J/8CucccjwoAb/3Tv0yTHthDj5b9026qlMhwsBtDX373siX3RfOhgF7C8ZhGcRw1pafRYynkeY28MD+A/FgmQdDehcndd/Wlib834K78a/l2VnsMLDYHqXyVdf76rNiwF6AcVgGEUpmjR2gIrYPAZSkI6e4Zx88d3ENnL36dXhtebAey4Or0dQSgrNPP3x/2IFw5LWP54d1FBMfvwVvrFyajhkpQ0BQKzovOM3336wYsIdjHJZBhFJvuY+B8nRkKCI8PWk6vu9sX1L41JLXUfvEo/hs9cp2z/fqUYjqCZfi/JNORaGjYMfzjU1bcMrfpmLdtm/TMScdmgh0Sb3H93i2DNhT6Q4Zx4YcZ2CN+3gGytKVM+6wH7ZzVlGtMeWvd+KSu6d3cFaKCHOumIZLThvdzlkBrfGvqSem5TvTpQeD55bWuidm04g9EeOwDGlBINLgOyFwIjjlhLHtHlfNux8Pv/pip9eOOeYknHnUsTFlXfC909G/MKu5qgrM/3DWuA/NphF7GsZhGdLC6S2bKFFyc1D/QTigr2vH4/99/SXuff7JmNcfPHBIXHl5yoYzRoxK16y0YCCPFN+cVSP2MIzDMqQMgQjADRKyThhyWLvHf/vX09Bx4qsfrujYg68lEsbmpp3J5ycNOVzCtPRg/Lyk1i1myCdTRn9/6ZTRsz6deqZTSmZ3wjgsQ8o4veU/BXCwhKzSXv3bPX79kw/jXv/C+0sw7/WXdzwORyOoePBevPXZztNBVycnjenADEB34kTjn1uRYn2lhP6Pp4yerYH3AFwTjar7JGR2N7LdOM3QreEpUpL2LShq97hhU2N8zcy44i+3Yc6LCzC02In3vvwcK9c14HvDDtxxTZ8evaTMAyKM0PImcEQj3+mArV9rOgU3a4S+bgI0kD+kAKqosxQ0+jmAy9M1gQkNuzjHc5ZOPvvokbOf3asy7M0Ky5ASpTPcBwE4U0peY9OWdo97FRQmdN8HK77Ak2/9GyvXNQAA9umx87712+XSGiKbI+CwBhhoCYballtAeG0LOMzgKCOyMWaS+35DvBf0SdcG1vx5uycUX5quzO6GcViGlGDNF0NmSAQAILB5fbvHI4cMS0nOyMFDd5G5IS2bdkU5dn5VCABz25++yxaR7LG/Tqx0j3RtYKJV7Z/A6enK7G4Yh2VIlbFdX5I4r61oH7MqO+HHScs4cv/hGOEaFFNmOqgiG/KK80EFCvbSAlDbN8e+Xz7IoWDrZYd9v9hddKI2aknXBrKrtbs9NfyT/zulZ7x7Prpq9GVLp4xuWTpl9IMgEvuByRbGYRmSpmT62JEADpKU+fWmNfh07c7k0PNPOg0jBye+ylJEuPmCX+14HIqE8cqX70maCPuAfBSMKIS9z87QryqyoeDAQuTvXwCyxfQHLYFr5qW93HMo1aHjaSSvoDTW9R9POWsCMe5Faz+ySZ9cNbo7dnxth3FYhqQhm110dfUdt79Rt+P/bUrhkatvRHHvvgnde9OES3HyoUfueHz/u89jU3OuNAalTxnp18BFehV0cFj2CHd6cPbRVWeNZtCD2OU7ztHOr+1OGIdlSBrF/CMr5D63bAn+s0vR8pD9SvDqLXfj1MOPinnPgN59cP/kSkw+e9yO5xq2NGL24iesMDE1SIuc5B2KwyIA2jULjNjsHZZ1H00583Ri8qN9p9cv1vVvWiJhRzbp9h7XkFmoulo5HTjaCtkMxuVP3Y5nL67B/m2tZUr69MN8z614Z/lneObtN7Es8A1C4TCcffrh5EOPxJhjTmxXSxiKhHHpEzPxbfM2K0xMDQ0RR/HRmrf3JXv7RYYi27p210wefR6Rmgdg1wLLZgV94Y+rFmWtPasUxmEZkmJA3rL9AOxjlfyNTVsw/rE/4oFxFThkv8E7nj96+ME4enj8HNXGpi349ZOz8H4wpybRt9htec+KSFK8e8Z888i7FqzFncAn/3d2SdTGfyTCr9D+9FaD6OJD73phj2h3Y7aEhqTIR0tyXfVS4JtNazHm4evxwHsvIKyjCd3zr+Xv4Kx/VGDxN7k2uJn/8c20eQERUUq7d3tm5ceTz7ro46vO9mkbryTg12jvrKJM+O3Iu571iejPAUw/LENSlHrLvs8g2eO3OAzt48TEI0/FT0f8AMP7tT8QW7ttE1764h34l76Gt1d/limTkmG7XdlHSDisT6ae/T0d5SUA8hO8JcTMFx0++3l/urpzCeOwDEnh8rpHAZyVcpACez5KevVFvs2Ohi2N2BxKfcpWaURjwpYw7t83HxuVNelJBNxc7/H/IV05H08efSIT6pBwN1f6jJSedNidz7+dru5cw8SwDMmhNEFnJ/+wOdKCrzc2iMiavLkFRzVH8cPmKJ4tsuOVHnYsz5OLkBAQbA45Zu3+/LuXH52XbyvpkOzJHM6jHnk7nleRSC9mOhxE40AYg8TCN80Azd5iL6o6/nZfU3p/QW5iVliGpCipKTtWEb2VbTvS4YdNEdywMdTh+W1EWGMndBY1szNQ0Ml3xQ5Cj06e76G52db+pM5KWkD0N81cc8Tdz63OkM6sYFZYhqSwQyndRT+VXOebPBs+yLfhey3tXVMRM4aFk/3bYl6fCWfVBNBDStmmH3rngqzMN8s0xmEZkoIRVd39cPlrO2Fa/wIc2xzBuK0RHBmOgrqRD2bGEhA/0BKKPDbqvn9lbdJGNjAOy5AcykYCVSY5wZICO5YU2DEkonHWtgiOaIli/wjDnlt/3xoAXxDjE0282Bbl/xz65xdyKtEskxiHZUgKrWHr/jX/7VlpV/jLvq3ZAgpAn6hGXw30ijJ67uK8Cpk7XVvmMeBgYP+Ifum07ZGFu76miHrv7EXTOZp5E4hYMW8B1BrNWGdTvN7WI2/VQbX/3BLv3r0N47AMyUHxv3zdHQ1gg01hgw3tK/G6glAXrKhzSxQ5G2LTvYMRhoxj0+mNod8TIaJFjuaeFxlnZT1mhWVICraT6nQQw14KAUtaKHRufZWvOdu27A2YFZYhKZi1+cy0QYA/au9x2rppJs6UKcwKy5AUDLKokKX7QECYgaqAp85rtoGZxTgsQ1LwHnhKmBz0sib9u2BF3cfZtmRvxDgsQ1LYFFMXp/R7IlEQPc3R6N3B6+YvyrYxezPGYRmShPaWGBaD8S4ITyCq5waun7+y61sMVmMcliEpmEl1NZu9m7IBjPcAvE3gt1uYl6y7bn4w20YZ2mMcliFJtBKcn5oI2wF6B+B3mfhLAOvA7Sv/CLSFoNv1K2fiFrCtQ2P3qE1tomik3f06pNaurfLlyogdQxyMwzIkBRNsGSoUfhegOWEVmmfSBgzfYRyWISkUK2Jrt4SvK6aK1ZW+xVYqMXRPjMMyJIllW8JmJr62oWL+PSa3yRAL47AMScHWnBJuBOPcoKfudQtkG/Yg9pYjaoMQTOLFz5qA8YFKv3FWhi4xDsuQHCy7wiLGvfUe/0uSMg17LsZhGZJCQbb4ORql2yTlGfZsjMMyJAWz3JaQgGDDDb4VUvIMez7GYRmSQ7RZA5lyF0NSGIdlSArJoDuDI11fZTDsxDgsQ5KIxrBMvpUhKXIqD2tktTt/YwFKoqztNkY+bIrDhG+LthdtWlH1gGlBmwIDqt09ezjy8gDgG8/cTekmZcpmunenaYCGXCArDov8bpvrS30EM44GaBQIhzOwPzlQAoZSIDAB0Aw7gJBjK1ze8g0MfK7Ay5jpQ7bRmw29+7zPl90XzsbfkCuUVo8pREHBUcx6JIEOZ+BQBgYS0BtAb7sD9jBaAABObxm7UL4WQACE18D0SMDjezcphawVxDr4sRYSJELJLe6hlMcHE/PBYDoIoP1BXASiQjD3BgAQbQLzNgDbAP4GrJYx9GccVZ+aA4SdlN42sT8ikYMBDNaMUgIPBNFgYnZy62czD0ARgG0AokS0WjOvUMDiFq2fjdUpgzhDVRB9a937FjD/DMyjQfQTAP0FxG4H0+sg/ZRd5S34Ztq8gIDMnGdg7dgjGfazwHwGAycCcKQqi4CFRNGrV1c88WEi17tqyn8Hwh2p6munm2hRfYXvVAlZqbDf9HFOu7L9lKBPBegUAAPTFLkawEIGLYro6It7S3uaklljB1BYHQ2iUUR0FJiPAjA4DZEM4ClNVNVQ4fto1xcsdVjkd9ucX+IMgCcBOA9AD8uUAQzQm8R8P1pCj9dXLdhuoa6MU3rrhEFsi04CeCKAQ4XFR8D4faDSf2dXF7q8ZVMBul1CKRNeCVb4T5eQlShDqy8paHZsPUcBkxg4E9btMjRAiwE8FAlh7p7WvsZZW3aYYvoZg84B+HhYEw+PEHBDvcdf+90TljisodWXFIQKtl7MjGsJGC6uoAsI+FaDHwbybgt65n2daf2SlNSUHWsjuoaBn8PiLTyBZ9Z76qbFu8ZV474axELJnvRywOM7Q0ZWfIqnTyxWtvDVxPgNgH0yoXMXtjDhXh3Nu33NdXPXZFi3GKW3ThgEW+QqBsqR3goqOQjXByr80wFhh0VzLs9zbtx4BZg9AErEBKdqDxDWhEfsTNNXeXzLs21PMrT9gnkZ+FlGFRNfFKioeyTWy05v+TUEzBLS9lLA4/+pkKxOKZ4+sViplhsIdCmsXeEnQhOD74/a1K1rf+9ryLItCVNS6z5csf49gcZzcvOwpYiy1mcEr5u/SMxhlda4xzDpmQAdKCJQlgiAexyhSNWKqic3ZduYeNCcy/NcjY03AvBk5cNB2GTLpwNWTfU1dvays6b8WiLMFNHF9GKg0nemiKzdoOpqVVKw9EJi3A6gnxU6UoWAb5moKjgMf+JyXzTb9sSitHpMoXY4/kDAtUDWJ36/GfD4T0x731k8fWKx0+tewMT/zFFnBbRupaaEHPZlTq/7FyR3zCVKaU3Zwc7GxsUM3JilXzKA0TsS4ktivk6C7x1ZE0AdWDv2SKdj6X+J8SByzFkBAAP7gvlO51f478DasUdm257OKKkp/xk7HJ8SUIHsOysAOKF0+rij0nJYLm/ZOJsKLyXwOVJWWcwAAj/g9Ja/NHjGBFe2jdmV0tryc5novwBGZdsWAmL+eyrRGV8kntbgrC2fpNn2JnLgfewS5qM025a4at1XZduU76DqU+xOb7lXEZ5GJuNUCcCkfpiSw6I5l+eVesv/DFAdZNITMgyfHtGR91xetyXbkWQgELlqy29gxhMAemXbHgAAISO/+iTYWXRAtbun01v2WNuqqlBKbgZwgPlOp7fssQHV7p7ZNKR4+sRip6P/y22rqtyDOPkVVultE/s7GxtfYuAKK2zKIMUAP+eqLb8hWwaMmD3a4fKWPQ7GzcilMilG7xGzR3ee20Vy/ZG10Aqr9LaJ/e35/AqBzpeQlw0IdL49n18pvW1iVhYAzhr3oTYVfgfAj7KhPxEYqndSX5LimeMP4Ej4vwB+bI1JGYfAuNnpLb+f5lye0ZhRyaxJRdu2FS1oOyLONXh547GdVhCwoGMlgUz3wTMmuBAOLwThGAmbsgrhGLS0vFU8c/wBmVRbOn3cUUT8KtJPnLUUAmwJf/gGed3DbdHoq2AMtdKobEDAL52Njc+UVo/JyFaiZNakIhVpfhHATzKhLwW2cFWV9WUzlF4tYemtEwZFdGQxA4dLmZRtmOgAWzSyqLTWnZH4UWmt+yQotRDAfpnQlw4E3paQwxpYM/7AKHLfA6fJT9jhmD+y2p1vpZIRs0c7VLjpSYBPtFJPmsQuKRHcEiKNnJqBNWP7sS38InIsMCwDDWLml0tmjR1gpZaSWvfhDH6agX2t1CMFEz7o0mENrBnbjxF5DkBpBmzKNmc2FuBxqj7FkoxyAtH2rUUPgZCR7O5UYcKbcV7M+ilhafWYQib7MwAdImdLzjHCFrEtsGrVXzxz/AGK+V9g9LZCvhUw8H5chzWy2p2vyfYkE2V0T51VmM9zOfrfZYVol7esmgluK2RLooDYQyFIMK0h1Twsh+MeBh8nZkeOwsCx7HD8TVruwJqx/eyRyIsAiqVlW0h9v2Z6Ja7D2uDgewGcnCGDcgYGriitdU+UlOmsLXMzkLUTyUQh5i8DzevrYr3OLLclTKWxVqm3bAIDF0vZ0A2Y4KwpE/t7qbpaadgf7YaLkD8vrfK1xHRYpTVl5xHwy0xalEsw8xxnjVukK0LJLe6himkOLBqZLEiLhrqUqxbFbl0smOmukzwldM0YfwiD/iqlv7tARH92zRgvsv11OZbeBGJL6zfFYfy3qGjb7UCMI+qSWWMHMNGczFqVcxQp4sfSTXeg6lPsys6PdIPA5homGhus9L0W9yrJTHdO/JSQQAQdvQetTd/2Noqgo3PSLSkrrRl3IgPXSxmVIb4gbS/7YvJzISCGw1JR273oBsecVsPA4SUbGtMqm3A5+l8D4AQhk1JlG4CNAJp2eY4BNAD0MjFf5QhFDg5W+J7tSpASXCUmk4dV4i2/GFnI/yMgDKAewBcAfw5gddtzmeakkppxk1K9eWj1JQVM6n7kUoJyHAgIE/BgKOQ4uv76eau+e77DaVipt+x0gMZm2LggAx8A+IAIQda0SYM3EqiAlC5gpn0UYSgzHQrwkcjgiSUR/jB4xoS5qXQzbW26hxutsGs3GMBiMBZqYEmenZepqGP9N6HAlrjbu5Q0sVzteIJ5WEO8F/Qh8AwZpfEh4FsGL2DGK8qm3go0rfty9/eQ5lye59q0cZhmPpaYTyfQmEysoIloxhDvBQtWeh7dmOy9zY6tFQQcZIVdMVgD4HMCGhhoAXjbzpeoFwF2ZvQmgo2BfVvfd7QA+JqBj6I6b35nvcPaOSwCkRPl0zM0zGQZE80F9PxARd3Hydw4aHrZEVFFZzPwyww0COwViYZnArgg6Tttkdtg7RamnoH7GPxog6fuKwv17ESyW0OCK6wwt1wNsnrFT0uZeKYtn/yrpvqb4l3ZNkdgWdt/Dw26w90j2owyEKYBPNJCIweEueVqILkfwSHeC/ooYKrV32oGFhP4IR1RL1rV375dPyxnjbuMiP1WKNqF9wG6ORg67J/pZlNTdbUqzl86WhHd0rbysgqt2HbI6srHPk/0hpKasmMV0VsW2bMZjKqintvu/W5vnylcNeU3g8ROOx8KePxxT8D6VV+4j6MgtNLCfKE1YPp9sNL/SLoThQhEzpryC0E8E1alDBA2NYP2b6zwfZvoLa7a8uvAuNUSewAQsIRbW2y/bpWO72i3nyVClYW6thDzVcED6AcBj+9JidIPrqrSDZX+Z4IHYBQTXwnAqj7uihH5XTI3EClLgpsELLQr+yGBSv+dmXZWrQbIBd0TiWEVFLRcYZWzYtDTiqOHBSp9D6frrFrlMQcqfQ/bHHQog56WsLETJb0LwP+X6OUEImbE7m+WHk1gTA2ERp6QCWcF7LLCKq0tP4EZb1ikZxkxn1dfWfeZRfIBfNfKlecDGGGB+O2Ko4NXVz6xoasL27asH0A6jYH49uAwNS2bXSpdNeW3gnCdhCwmPBCs8MdMnSG/21byJX9DgHjvMgJuDnjqqiQcVefyiZw1ZX8UXI3uSkMwtH5QIvFJV035ySD8W9oABgKAPi/omf+2tOx47FxhMf/aCgUMLHaEIsdZ7awAoKHC91FU551MwEddX500hUy2XyVyYcRGv4O0s2LcEqiouybrLXUFawm7WmE5v9KnW+GswHRNvcf/B6ucFfDdast/I8BXWyC+pKSgf2LlXYqtSLL9SkXtx2XaWQFtDqtvrXtfBomXjBCwpCXkODOTfdTXXDd3jWY6DYB4EJoZZV1dUzJrUhElcF2SPNL64c8BMtlxVCPlY/w41AQqfSJjyhIh4Km7A0CNtFxiXNTVNSNmj3aASbp9UQOi+tRdUw0yiQKAHsDZkO/SuDpso/M2VD2yWVhulwQrfeuYeAxa84/kIIwadKs7bkqFim7/OWQ7hy6zOegyQXm5Q5xuDQOq3T1BdJ6sPnoxGBqZ8fKoNp2x6zNT47yuOpRu3Vp4GmRHmmlSNClw/fyVgjKTonVLyCzdl4kZuCibo4yCFXUfM7F0q1eK2DEm7hVMyac/xJGmQVesmuqLe8yeSVgyrSFOprutgE+G7I/oxijbL85In6/d4KoqHdV5k9CavCtFD1u+/mG8C4hIetbCXfXTfP8SlpkUikCkId7u5P6gx/+qsMykaaiYfw9Aovts4thzAtt6acX9ECXJCw0e30JBeemToRiWYj5FSg8AMHBDNoeYrrlu7homEj05VkSnxnudmCW/1xsVRy1LjUgUVVxbPlI4sNmQh/y404MzBYOZdVR4lcUxp7E05vOxEFwVaJDUwFIxlGhpR+wYFiP+lzE5eFW/EIm3aUmWhj59/gbw11LymCimUx90q7tUsiMDA3ckckJuNUppLdtXiFGbSumAVQSvm7+Igf8Jiiwunj6x86RAJdjAn7Ai51ZXwugY/bDamtZ9T0wRqduWVvlaxOSlCF92X5iI5AL+zN+LFcfSNpwkpgfQKmr/h6C8lFFQOFhQ3sZIS/Z/yXaHwPdKyrPbI0d09jwziQ1CYI1npGSJItgPK1YMi/IKDoTc8M4WstsfFZKVNiqfHgUglfCr8hy605xDFq38oIXZOhXcHQVWYg6LgL+vrfJtlZInRViFH0VrYaUIHO186AGBBZui8QtysuRgyUx36jyGxUqwSJdpUf01c9eLyUuTVVN9jQDkVs5Enb5XBHT6o5qSCvDLUrLSRYFYrC92VOmYnSqzybpp/9wC4L9iAkl3GHzQ1sJAbKKQXasPpWTJQpbHsDRY7EeUCa9IyZKCQYukZGnu3LkzINfvnvV/xGSliQJjiJCstWuajpBzCuJw/MZ0SUCdtBIpnTG2FEAPIRWbV1/vT7qdTUaQTByNEcMisNwhkI6+IyZLDBY7uY7zXjmFVEQKezblzHuoIHbqwxuykeOSKAy1XEwWUYdkPNYk1v6EgJVWlo3kChQrD4shNrI9z56/TEqWFBGtxWxi7vhZHOK9oA/kfjwDWSmyj4GCWPMryT5J8ihisZPLzpq1aaXEJkdrIOfigDuxvh8Wk5KqFOBVQ6NZy72KxfrwEWsg9L1T1LGqQttCkuPuVwvKShtBh5XbAxZYd/wlShXq5FdNRaNiDotAsiVFgkhOzdExYliKxFZYzVkvFu+Etp2IyL8xgzo4rIiG2DBgam0PnTMIBlAli2LlIRKMi4A7LJFZiR3DpzUR2XIkTwlj/J3JTtOJQy73LxcZ1kuEDg7ZBi02CJiF7JRC8sQnpx0WBE+eAOpQ0E264wcnDXJ2wo6SnPwco6c7gbYIaXC0lUvlFG2TxQskZGnmDu8Vs5J01H0FZaWNAiDya8Y5viXU6DxfJRWYuYPDUnZaKyUflLsOi5XcdgOxBqkyi8Xw1jv0QClZUhQ7+nVIi0kVAjp8FqNAwu2Tu4YHyMlKHwUhR6NE+yTJMrT6kgISLPUg6uiwtm8vkAzuuuRG04jTR1BWpz+WnX0JU4VIyeUjCUExkj1TktXJCiuqwuvE5IOG59IqVZHUCkt0moosTY5tJ0DumBdgNO7+VFvfL6k2ML2KbynfX0iWKMxyI9ZIdX64oEFfi+nQnO2ZkB0g5hOlZGlSHabTtCVKN0vIZyDv2zwtWb6XFnJ7XcG2I9Io8OmS8ljRp50+L3iiYstjsdIKKUZWu/MJ+L6UPEbnqSaKtFw7bSLp1knpw3I2KeJYk5zEav80ZX6AbSwUS6U15PCWEKDRotKIP+n8eXwgpkSL9yhLm015fDKEgsVAbIdF2i6Y7Mk/KJ3hzuQA0bgUzxx/AAg/EBNIFMu5d/oZTQUmOktKVrrs8aeEztqyw4RnFmqtCjtdYYHxnpQSJpyTa3EsrWTHRTGrTouS61vWfAW57TW0ZqvGXCWNLRL5FeQOqJoDvfvEml0g5rAIOG3wjAnyw0BSYI9PHFWafiss8uuGax/qNPZCwLuCegYXe8tFu26mQ4m3bBgA0YEGeVF0upLiqkURAhZL6SHgt23lKllliPeCPiC6QkoeES1um0Ld8TWw2OQoBvIiOpoTTl/QYeXelnBgzdh+TMKrAuDVWK8pB70DyOVjKfC1UrLSRRHVAoIpDcDGVdf7Ysb8mCDW0QDAPmEKZXz4xO6EqeUPEBwKweCYbWpIsfBgU/5d31p31tNtxNImbTorAAAOBklEQVQacnFLqJXtBghPAyLwc7Fea+t19KagujNdteMke8SnhLO2fBLkR5ctjfei0iTbFoZpSun0cUeJykwCl9c9CowrJWVSnL5aq6fNX03MXwqq6+9grhSUlxJiiaPIsS2ha8b4Q4iR8EjvRCAg3EwqfjMzpqdEVbK6b8Ts0Q5BmUlRMmPcccS4R1wwxW+xUt+y7m0Akrltdq3U4/2qL5Qce5UQ/aov3IfBj0G2zGVtoHl93HZOrGLvBlKBgN9n+wdULOieS5nuI6vd+dDRhxkQK0gGAAbeaKzwxc0ithEWSOoEcPD2bYV/EZaZEC6ve5SKqmcBFEnLJsbz8V7nqkUREOaJ6gSGFzhCT2byB4DmXJ7ncIQeJ2C4rGSe1+Woek0xdwMposDq4WwG4MViWCqHHNbGfL4dQMzpNqlCjIe6umaVx7dcerQYg35RWlNWLSmzK0pry84B+FWQJbVkWwuLtncZYyHmLt/vZGHg1O1bix7KRPb2yGp3fknjhocBnCkvXT3c1RW2AnoegFRd5ncMjujoc84at1j/t2TY41ZYTm95FZPsVrCNjWgJPZ7QlaTvllbORH9wecvvaiuctYwRs0c7SmvLZzLTPwG5RnrtIHo5kaZw9Z669wESbxXNBHdjPj9j5cnhEO8FfRrz+RkCnS8vnZYGPL4uT6RXTfU1gflpef18JBH/Oxv5bXtMWgP53bbS2vKZBNxkiXzC/fVVC7Yncm3fZuUjIGiBGVOcjv1eLbnFLdY7/jsIRKW15eO3bSv8jBnXwsJ/T4L+e+JX80yLjDgjjNB7pTXjxMpkvqO0tvyEMELvgSxK/mXMSPhSRY9YYgNwMGt+z+ktvyKT+YJ7hMNyeifs71zOz7d90awgEuXER4UtrfK1aEB0tNhO+ERl509c3vLpA2vG9ktXGlVXK5fXfabLW7aYGfMA2j9tE+PCqwLDVMKxlWBo/ePCp127QPszqX+7vOV/lYjLDJ4xweXylv+VGa9b+D5+FWxZl3Bsr6F55ItAzPKddCkk4M9Ob/lLpbXlGanZJGdN2RbILP3XBTz+jLaiKJk1doAtYruSgWshWdy8G8R8b31lXVIJf/2qL9zH4Qh9AcDK92Q7iOcx1JP2fCxcNdWXcHZ4aa17MIMngflS653UThi4KejxJxWPc9WU/RpEc6yyqY0QwA9qxt8bKuuWJHOjc4b7GIryL0G4GIKlS53CfFmgsu6vydxSWls+mRniYYpOeI2BP0dD9LxV4/7IWVO2GejYFzoF1gc8/qQCcaXVYwq1w3GMAjs1lAOs19qUrg9R9Ku2ivMODPK6h0dJHwfQuWCMgWwyYwcI+FYzjQhW+pJu2eGqLb8cjEyd8G0nYCEzPgDhM630l9C0VkU5CgBktw3S4GHEOB7AKYDg7L9EIWyy5dMBbflqid9WfYq9xNH/XclZe/EVYgUYrxDTW0D0syhR0AHHRgAIIdTHxuwEbAcz8XEgnAaWG+8W3yx8FAitP6rL08Hd2G/Gub3ydP4KAGmvyBOkGcAiYn5bK3yMKK+zwbYxovRmBdUHFC1ibRugoF2ayEVgFxO5iGEjxlqAXspvCc9fUfXkpt0FSzqsDQGPP6Hm964Z4w+Bjl4HYBxir4waAFqF1gLZQrR2PhwAQLLBfpcQo6K+0p9wzKDdvX63zfUlv8/ofPDq3gYBnnqPvzaVe0trxp3IpF5HjhzuZAFmplOClb6UxtW5vGVTAbpd2igLWU/ginpPXbt4p1wMK8HhBE6v+/ekox8CuBDxt3ElAP8AwE8AnATgUGTYWYHwQWHPbXelejuX+6Ig/AaC5TrdmHqEQrNTvrly/htM+IegPd0KBh5I1VkBQFHR9nsA/lrQJKvpz6D7W0/Gq3dkM2S0H5arxn01gWdIJ3RaRLMGTUp3Jlt9hf9NAqZLGdV9ocmJnrLGoqA5cjUIHRrW7fnwKhtHp6Uj4YvJz4UYlJaMLDHFmb90R8xTkdQKqwuH5fK6RxGxV0RXBmDiaxsqfCIV74HQ+j8S6C0JWd0RAh4MeHxPpitnRdWTm5j1+QBaBMzqFhAQJqLxqyuf2JCurKDH7yeGT8KujEK4vsTrPhUAFJOMw6IutoQM/ftusrICmOc2VMwXq5/jqkURjkbHA2iQktl94FV25E+Vkhb0zH8bYI+UvFyHmTz1FX6xgnpC9Ap0v88hKeB2qq6WGwcUL9O9tbUunSuly0oIWNi3RV0iPSo+cP38laT12cjpqc7iNDF43ErPo2JTtwEg4Km7gxkpx8O6DzwnUOkTDZSvrnxiA2s9kYBO+2jlLnxksePjH6uYo5aSJ6bD2lQQOQRW56cIwMD/mojGLq3yWbLlqL9u/ntEPBF7RxCeAb6odUUkT8NwmgpCnRWycwEGFgRDG6woMUPwuvmLAP6NFbKtxMa6THLgYkyHFdX23oJ6rIHwgdZ5P+mqG0O61FfUPc1M47Fnx2EYjKsDnrr5liko90UdzT0vYoJs36wcgICFBaGe5yebb5UM9Z66vxOQ0YL6dGGi4zKywrKx5GBHS/iPozlyyprr5kr2X4pJsNJXx4TzINi3PIdgEE0NVPrvtFrRiqoHmvs10+huGUiOzT+Vg362ouoBkTFd8aj3+G9qqxIRDX9YBmGoglDQHXEcVlM4P1aj/OxD9BSFQj/tLKvWSoIV/udB+kwAYkMvc4AoA1cGKnwp564ly9IqX0tgOE0EMlZRYBnEfG/wABqXTIlVugQ9/tuY8AsAaaXvZASGjZw1Zeshk7LfFPD4Y7YjdnnLvwQwTECPFBFmVDZU1t0mHWBPhoEzxg1kbfMz+Lhs2SDEZiK+sL6izoJ2JonhrC2fRIx7IdwWOwOEQFSRSUe/O64ZZUdDw5/JutKkIazIWLcGBvxCeiT4hohOCVb6Z2XTWQGtvbcLi7b+mFq7QXSPpXkHaKkNNCqbzgoAghX+hwh8EoAvsmlHcvDXmvlH2XRWABCYVvdOHhxHAWRZ3DFdWGNJRoLuAKCI7gGQVqazAFGA74qE6LD6Ct9/smzLDr6Y/FyovrLuCjB+BHQ++ipHiTBQW1S09ejWTqvZp95T935YtYwCcDdy+zQ2yozZYRU+ItnuEFax0vPoxoDHV0ZEF4CRVIF6JlBET5GzpmwtAIl2py0Bjz9ur2ynt/xGAv4ooCtpCFiioSdbdcwuRWn1mEJd4KgixlUAsjZ8omvoQ1a4LDjNF3cQQjYZWDv2yCjb7iXg+Gzb0g6i95jw21x+74qnTyxWKjydgF9AdOByqvCnwdCGI8S2hJRAFX1D375egOJPnRGHPiSmc+s9/uNy3VkBQH3Vgu3BCn+FUno4wHMAWHa0nRq8CqDLgwdgVC5/4QBgdcUTHzaERp7EgBuED7JtD0AfMuAONh/2g1x/79ZcN3dN0OO/FIqPBeIPDMkAUQ11JVctipCzpmwNZJrMRQIef5elN6XVYwrhcDzOwM8EdMaCAXqFiP8UaB75NFdVSY0yyziDZpaNiEbpagAXQKYNUKp8xkR39yzc+vd0C8KzAYGouKbsbEW4BsCPkLk2NQzg35oxa01l3bPZjpmmimtG2dEcpWuI8HNkeOVPoMn1Ht+fgNZ+WA0AigXkRgMef0IDEghEztryKQDfBIZkUulKAuqg6K/103zdKRbUJf2qL9wnv6D5ImK6FMD3M6Q2xMCLRHxPsGL+S931y7Y7Tu+E/YkiF4L5IoAOtEYLf86gRwD7w0HPvK+t0ZF5Bt3h7qtDmMjAuQD/ENY20GwG02WBSt+OCUGSDksHPH5bMjcMusPdN9rCvwHzxSl+cEIA3gb4NSg8FZhW904KMrodJbe4hyq7Pg+t9ZnHQ/JDw2gE0SIiPNHcnP/MhqpHNovJzkGKZ44/wBaJnMqgU4lwMoDSFEXVM+N1Ai+0kVqUK4cQVrLfjHN75XPej5lxLKCOBfhIyMTDGaAnSOH63Rce5KwpCwIokVAS8PhTDs4Nmlk2QkdxMoNGAhgGkAsEG5h7A/i27b+NTPhCMb4A4ZPCwm3vdsftiSQjZo92bN9eNIqZjwXjaCI1jMFD0fWPkAawmoDlTPgSmt9mqDcaKv2f7ikrqVToV33hPvmOpoOI6CAwDWJgX8W8D1Pr3ANibNVEmwn4FsSrmHlZiGyfW13S1V0Y4r2gT4hDB9oIwxgoAWgQM5xEGAhQL4B7AawA0mgtT9vW+v+8nsBrAPUuCAvqK3zfdCZf0mEh4PHvre1rc47S6jGFUUd+iVJ2B7QuZEZPImy12fTm5jBv7d2rqXFvd/aG7oelQzkN2aOtu2fulkQZDCkg13EUrcF0KVkGg8GwO7IJYdU3GYdlMBgsQ2nJ+rVDPzYOy2AwWIbolhCfrDMOy2AwWIbsltB5oHFYBoPBMiTby+Cw4EbjsAwGg2WIrrBCfbcah2UwGCxDQTCrOdJYbByWwWCwDNEVVmSfbcZhGQwGy1AAia2w9OZm47AMBoNliAbdo0W9jcMyGAyWIbol1NvMCstgMFiHaNCde4SMwzIYDJahABKbMEtNjr22j5LBYLAeBUBkPDsDgbVVvq0SsgwGg6EzFAjvSwgiIMPTcAwGw96GIuZnBeSwZr5HQI7BYDDERAVChy9E+p0pH8uV6bUGg2HPRXFVlWbClWnI+MTmoHTuNxgMhoRQABCs8D9PQCpbuncpaj9z1VRfo7BdBoPB0IEdiaOB0MjJINyI1tE7XbEdjOl9Q3RC/fXzVllnnsFgMOyEeLe8Uad3wv6Kw5cw0ekADgTQG0AzwAEQ/Q/Mr1Befl39NXPXZ8Ngg8Gw9/L/xsTpTG7X8O8AAAAASUVORK5CYII=" alt="pdoc logo" /></p>
<p>World!</p>
<p>\( 42 \)</p>
</div>
</section>
<section id="include_options">
<input id="include_options-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">include_options</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="include_options-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#include_options"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="include_options-140"><a href="#include_options-140"><span class="linenos">140</span></a><span class="k">def</span><span class="w"> </span><span class="nf">include_options</span><span class="p">():</span>
</span><span id="include_options-141"><a href="#include_options-141"><span class="linenos">141</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="include_options-142"><a href="#include_options-142"><span class="linenos">142</span></a><span class="sd"> Included from another file:</span>
</span><span id="include_options-143"><a href="#include_options-143"><span class="linenos">143</span></a>
</span><span id="include_options-144"><a href="#include_options-144"><span class="linenos">144</span></a><span class="sd"> .. include:: flavors_rst_include/include_2.md</span>
</span><span id="include_options-145"><a href="#include_options-145"><span class="linenos">145</span></a><span class="sd"> :start-line: 2</span>
</span><span id="include_options-146"><a href="#include_options-146"><span class="linenos">146</span></a><span class="sd"> :end-line: 5</span>
</span><span id="include_options-147"><a href="#include_options-147"><span class="linenos">147</span></a>
</span><span id="include_options-148"><a href="#include_options-148"><span class="linenos">148</span></a>
</span><span id="include_options-149"><a href="#include_options-149"><span class="linenos">149</span></a><span class="sd"> Also included:</span>
</span><span id="include_options-150"><a href="#include_options-150"><span class="linenos">150</span></a>
</span><span id="include_options-151"><a href="#include_options-151"><span class="linenos">151</span></a><span class="sd"> .. include:: flavors_rst_include/include_2.md</span>
</span><span id="include_options-152"><a href="#include_options-152"><span class="linenos">152</span></a><span class="sd"> :start-after: <!-- start here --></span>
</span><span id="include_options-153"><a href="#include_options-153"><span class="linenos">153</span></a><span class="sd"> :end-before: <!-- end here --></span>
</span><span id="include_options-154"><a href="#include_options-154"><span class="linenos">154</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Included from another file:</p>
<p>This paragraph should be included. Lorem ipsum dolor sit amet, consectetur adipiscing
elit. Donec semper vitae elit ac condimentum. Aenean consequat, massa sed
consequat imperdiet, risus sagittis libero eros.</p>
<p>Also included:</p>
<p>This paragraph should be included. Vestibulum fringilla metus nec
lectus tincidunt tristique. Vivamus erat risus, commodo ut aliquet ut,
imperdiet ac dui. Nulla dolor orci, mollis ac sagittis in, tristique nec ipsum.
Ut sagittis nibh eu ex imperdiet, at aliquet ipsum elementum. Donec vehicula
sem nec ante vulputate feugiat. Nulla facilisi. Phasellus viverra velit id
faucibus commodo.</p>
</div>
</section>
<section id="fields">
<input id="fields-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">fields</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">foo</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'foo'</span>, </span><span class="param"><span class="n">bar</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span></span><span class="return-annotation">) -> <span class="nb">str</span>:</span></span>
<label class="view-source-button" for="fields-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#fields"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="fields-157"><a href="#fields-157"><span class="linenos">157</span></a><span class="k">def</span><span class="w"> </span><span class="nf">fields</span><span class="p">(</span><span class="n">foo</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"foo"</span><span class="p">,</span> <span class="n">bar</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
</span><span id="fields-158"><a href="#fields-158"><span class="linenos">158</span></a><span class="w"> </span><span class="sd">"""This method has field descriptions.</span>
</span><span id="fields-159"><a href="#fields-159"><span class="linenos">159</span></a>
</span><span id="fields-160"><a href="#fields-160"><span class="linenos">160</span></a><span class="sd"> :param foo: A string,</span>
</span><span id="fields-161"><a href="#fields-161"><span class="linenos">161</span></a><span class="sd"> defaults to None</span>
</span><span id="fields-162"><a href="#fields-162"><span class="linenos">162</span></a><span class="sd"> :type foo: string, optional</span>
</span><span id="fields-163"><a href="#fields-163"><span class="linenos">163</span></a><span class="sd"> :param bar: Another</span>
</span><span id="fields-164"><a href="#fields-164"><span class="linenos">164</span></a><span class="sd"> boolean.</span>
</span><span id="fields-165"><a href="#fields-165"><span class="linenos">165</span></a><span class="sd"> :return: Another string,</span>
</span><span id="fields-166"><a href="#fields-166"><span class="linenos">166</span></a><span class="sd"> or maybe `None`.</span>
</span><span id="fields-167"><a href="#fields-167"><span class="linenos">167</span></a><span class="sd"> :rtype: A string.</span>
</span><span id="fields-168"><a href="#fields-168"><span class="linenos">168</span></a><span class="sd"> """</span>
</span><span id="fields-169"><a href="#fields-169"><span class="linenos">169</span></a> <span class="k">raise</span> <span class="ne">NotImplementedError</span>
</span></pre></div>
<div class="docstring"><p>This method has field descriptions.</p>
<h6 id="parameters">Parameters</h6>
<ul>
<li><strong>foo</strong>: A string,
defaults to None</li>
<li><strong>bar</strong>: Another
boolean.</li>
</ul>
<h6 id="returns">Returns</h6>
<blockquote>
<p>Another string,
or maybe <code>None</code>.</p>
</blockquote>
</div>
</section>
<section id="fields_text_after_param">
<input id="fields_text_after_param-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">fields_text_after_param</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">foo</span></span><span class="return-annotation">):</span></span>
<label class="view-source-button" for="fields_text_after_param-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#fields_text_after_param"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="fields_text_after_param-172"><a href="#fields_text_after_param-172"><span class="linenos">172</span></a><span class="k">def</span><span class="w"> </span><span class="nf">fields_text_after_param</span><span class="p">(</span><span class="n">foo</span><span class="p">):</span>
</span><span id="fields_text_after_param-173"><a href="#fields_text_after_param-173"><span class="linenos">173</span></a><span class="w"> </span><span class="sd">"""This method has text after the `:param` fields.</span>
</span><span id="fields_text_after_param-174"><a href="#fields_text_after_param-174"><span class="linenos">174</span></a>
</span><span id="fields_text_after_param-175"><a href="#fields_text_after_param-175"><span class="linenos">175</span></a><span class="sd"> :param foo: Some text.</span>
</span><span id="fields_text_after_param-176"><a href="#fields_text_after_param-176"><span class="linenos">176</span></a>
</span><span id="fields_text_after_param-177"><a href="#fields_text_after_param-177"><span class="linenos">177</span></a><span class="sd"> Here's some more text.</span>
</span><span id="fields_text_after_param-178"><a href="#fields_text_after_param-178"><span class="linenos">178</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>This method has text after the <code>:param</code> fields.</p>
<h6 id="parameters">Parameters</h6>
<ul>
<li><strong>foo</strong>: Some text.</li>
</ul>
<p>Here's some more text.</p>
</div>
</section>
<section id="fields_invalid">
<input id="fields_invalid-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">fields_invalid</span><span class="signature pdoc-code condensed">(<span class="param"><span class="n">foo</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'foo'</span></span><span class="return-annotation">) -> <span class="nb">str</span>:</span></span>
<label class="view-source-button" for="fields_invalid-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#fields_invalid"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="fields_invalid-181"><a href="#fields_invalid-181"><span class="linenos">181</span></a><span class="k">def</span><span class="w"> </span><span class="nf">fields_invalid</span><span class="p">(</span><span class="n">foo</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"foo"</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
</span><span id="fields_invalid-182"><a href="#fields_invalid-182"><span class="linenos">182</span></a><span class="w"> </span><span class="sd">"""This method has invalid `:param` definitions.</span>
</span><span id="fields_invalid-183"><a href="#fields_invalid-183"><span class="linenos">183</span></a>
</span><span id="fields_invalid-184"><a href="#fields_invalid-184"><span class="linenos">184</span></a><span class="sd"> :param: What is this for?</span>
</span><span id="fields_invalid-185"><a href="#fields_invalid-185"><span class="linenos">185</span></a>
</span><span id="fields_invalid-186"><a href="#fields_invalid-186"><span class="linenos">186</span></a><span class="sd"> :unknown: This is an unknown field name.</span>
</span><span id="fields_invalid-187"><a href="#fields_invalid-187"><span class="linenos">187</span></a><span class="sd"> """</span>
</span><span id="fields_invalid-188"><a href="#fields_invalid-188"><span class="linenos">188</span></a> <span class="k">raise</span> <span class="ne">NotImplementedError</span>
</span></pre></div>
<div class="docstring"><p>This method has invalid <code>:param</code> definitions.</p>
<h6 id="parameters">Parameters</h6>
<ul>
<li>What is this for?</li>
</ul>
<p>:unknown: This is an unknown field name.</p>
</div>
</section>
<section id="fields_exception">
<input id="fields_exception-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">fields_exception</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="fields_exception-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#fields_exception"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="fields_exception-191"><a href="#fields_exception-191"><span class="linenos">191</span></a><span class="k">def</span><span class="w"> </span><span class="nf">fields_exception</span><span class="p">():</span>
</span><span id="fields_exception-192"><a href="#fields_exception-192"><span class="linenos">192</span></a><span class="w"> </span><span class="sd">"""</span>
</span><span id="fields_exception-193"><a href="#fields_exception-193"><span class="linenos">193</span></a><span class="sd"> :raises RuntimeError: Some multi-line</span>
</span><span id="fields_exception-194"><a href="#fields_exception-194"><span class="linenos">194</span></a><span class="sd"> exception description.</span>
</span><span id="fields_exception-195"><a href="#fields_exception-195"><span class="linenos">195</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><h6 id="raises">Raises</h6>
<ul>
<li><strong>RuntimeError</strong>: Some multi-line
exception description.</li>
</ul>
</div>
</section>
</main>
</body>
</html>
|