My
z_-UmXi(Zbh3Gp+rqw|lj0y=4xZIfX~c0HC!STf;&Ssh7AFl%-VOD>NB9<+T%n`Km*
z<(Z-y@{k-wM}!5G_DET~=|TI@AQ`+a;9oP8FyuP@;gD+&Rp&h9Ikc7LjM9)(pFHGu
z#(<*QL^fJ4X0+9mK=VjZVk+tFW8-%YN^8%GE=ol<(K;S0T6JX~VGo;P@vbfEqQ;W4
zs)JH_Z9Gup!WheAzSf+jWL+VWQ~XcfX)cUi3Vn3vkDz%nRmV9%av&_IBQ2=vWVJ|9
zgUteTFnv&@v3)qbXlQJoi^cpmy45rA0W0QZia|vAoAJ2}cVjP1!);Kn>+oQ!Q3|-X<11+2KJf)W$BoD2Fz<
zoJ_%y)};decia3@lYPj%}r;3s6M4;vl1`FO6=|~
zE5Tx4P%|W*?rJ-XF<$6en*_l8X?N{5Y%E!*-CK{HWEWWT?12$X_G2
zb~vv`V2@iA%Z$8pDE}Ilk6}sU$Wa-OGGU=l9;B8Vd2(4WdTr83{cpE%K{5yf|8v|f_9@u_4y}ZoG6vLol9!NN)j?HCzSfS?!Vk$;_#ikI%VC=L-gc(kQ#f
z0hpf>!++fwna(MVGKZ5cg=-U+jQQPkjPzv80$}*<^{-rvs9`cn`F
z6#Ww}s>wm$bk0q~Tww(Nq%E4Hi8jLylF1L!IeW}V-*nFV1T8xUpk)rUhz_#QvXbeX
z4@anErzItdG^?UWGh98>-hNz1DM5r;6+{pnC886`a7j57n(TOD?=##_2yCX7naK+U
zPU6JsqIiMVeuu&p;3cu$YPQQZ_A0Q^T72BDEf}6#I=m}f67G6JloCrtwS%;^yK}Xo
z@S|@a2^RsC?nY^uj>y9jlYh8S*$_NXP4eo`iohM`tk5Eb`r_?_yMqOj+)t4>sCNCn
zMUrX0GX_fOjNH+Kvg(idxH2dow~G^Q;V7y0{GM0Ibl=@)fF=u;TRNJe?1I30tOnuxE;8_Z|Z~#=4A$P6o+1mesT=
zCs)-%A3_Ym_q+zr8)tC;5{mOpOyV{d*#KXmQ8VjpoQc
zUNyt=^F{{w!Oc9}6YKI2kDY484<5u(qc%cxdDjP964xc~VSyNV|7Hey$@UO3Oz)@^
z2MIY3l}3M`0?GVrLZ%m8?uDJY&{~d!k5uc7@t+P#^Ce01s>rya&R^w@;xKH468eC=
z$0$kJq<~~A9GWx6{rf4nhnN01e?=w5y+2BFCNe9!hUfs5lF|7<0y__4jdDjm8_Wun)gaffx+3%`*#e^Njxn8OmTov{A}rs$3FYdvkFmRJLuCF@7XSTG56A0*O^U41Qc31IjIU~ft;=)^L84kV&s5l3SNJA|vYZc{u2;M>aK5OI7KU?V95+4_8;MO06NRf|%oruw;IEPVDn
zLho3W2R8$WlvqmB5mNy-ljA#Y@sLkyU>Q%Vcl3hErQEQ*`dG^-Rp^8o_bjFv%s!xo
zrHAJka;+#+E6i{dhmysl0^!9?j*xfW5Fmvhc5>`GQWIiA5IqL77)@?`O>dC;SQ$Nk
z_e~2BLILkGL`pKR3dvl)F3I%bB-4LT#o74=bK~SPO{L>9qmcfXkXadF@H;sn{Z-JX
zJD9v_osuU$tMbHuo~visw0=FNqx~r%{aF>#4>}t4cLjF~B_R-wLZ;HNAJn?Ov6O9Y
zT2iAF6Pnhe?eF`b^cCrv6ocHyanGvG2crdZo=_s>#`*U|<__m~B2dO{NJ|^HjPhUQ
z@-ZZ8TlxoF3v*{ZybO~_EWltfnR#ItE=*sdB*N;v{Ch@S!*Sj96?bn6?*3>1?yiEn
zZ>5))@oND@;^3y9GFb;DWKVWnNqw@4{UAahso4IM9FzSj$K-olU3J#~%*Wet9i;@I
z_NxGt=qM4LFfQ~_CHhK;&VLOv1C|gTHja^9irlgsZ%WhZ#uRg;m;?EAHd(78=BjFy
z4vAxuDXMz7hJ$M&e~nf!m{fU&r5TF~adC>O@Kujg_bC^*nOk(~+H!GCG!|T3pYQNM
z?TXoK+VHdj&(OTwu*LSQ&3u+n6$<0jspj{k%SJ-6Mb3>hxxV<
zUR>ekksPP?1~Yo3B+_~bb7^(R*Q8_XbHZwldv?vHFFycJv6j^qf#X?6P_5bg>~)~9
z+ctI^TP-G+;Ud8Ip|(C@#Th?Z8d5L3G~BGqm_~E=^JKae7Y~QZxJfDFVMPLKqcte!>&Y&vMtt#iGF2O;RhGM4!|a-CM`M|mD}&NuNWG#
z`Ai>+^O^i#k}Gy~-=Cgyfe&I#7x8%vTu&HvG{^%W
zM~S3z(kRa8#qgyrd^uy%uv#URW)mL8QgmrR#JvSDUj@ASI!c?`?~LI}j?^7Wc>{)3
zS3GRr%s6b+KTrC7RXBmd%oj8L>7dlyLk6YKh$&9}#A3H0N*?)N;{D@K9hqj=5V_HIk1y}jej(P4Fy~+IuT~<85fG`D7osf
zfcr~p1#WhH0!9nF4CUgb@tjPDN&Ti9zNa!bHC@_Qntv4WuY;wBt=UKSS^MTq>tLz;
zNcmxFZvXyiYu_UWN{`GQ2)_hZz&vZW3I*KVu=}}v2Oiee{|`a`GhnThz|UF(a`8-m
zJ9r`Oi3R
zRCZqD9acCA$vfU}Xv!Jc%PGjJoWUzpGRPSWH7j;?6xH!;w*OPHwx5Erut!fHc_FtO
z|DIe9QtJ_UH)(%j!D?}S%!276#9z)K%|`e$wBBJiN^I>0UlGLDNcoNqB)Q?kK*cBU
z1DmMDhp-Qg`-Sj%L4@+P+lnwt(3gPriZ27vj8QujA%Nabveietp4M3SYO$J7gY(z0
z{gqa&nzy`?*|cEZrLb`-s0e7~8}7o?>{Rf%)G01cKXz+1Cye=aohK@_PCL6A@MyZT
zI_*Ole;ESRXRWvn!y^@B&Etv~7TMQQL^k-E9JkNrf9<5cnL~f2_5OtFJ$eA)-wxXQ
z5Q~`N!4Dp!(eRL>;UQI<5%|WSG_1OKD+2x1?<*O(EnTW6rD&6;MT%HP^V@@>x%Sey
zYQm?#;wVy6%Yp0Ec1inn*Y7s<-%H_Bnfkw^l7XowEoCj*q#K{GWxwlj3=Y|h|EJ@O
zzyHTiM-yg(TxZUBqzgmBBj#gA&OU^rB#)iNSE1?78+!p?1*A`*i})gcAJ9U|&RMH!
zHSr~M%Q)JoHSrZ`aq$Q?S-YCkq-A^_jDwDOno%xLKiAQRy4_?PvHtfb^Q8$_T1f!@
z6AX}UM!T+0@lUKENKzi3Ss~aJpR9))b0lernOpLb72;W}q-o$(JN|n9I~5gEM`iWK
z8bf_aVYLeVD9#zddj>@?n{s|8Rylv0bKMYEuTrA3bs0-uMAvCiEpsa2p7F`B$9far
z`s?v&dl4?3(AyyNPi^ihA!`knt8wG5Sw`HQQZAAD29Jt92Woq@U3pUT3w)aFl50G)
z(0a^RxG*LD)-D(#6+FIT)T=RA$wncLXBoFsOFxU$>8CQ^{qsTx8?aN`iqQf|%I
z>(0~XaavP*a$@-~OSikVo7m4WJbGcw(a!?*v#e@ZWG~uZ!uKqVc9Sph3tAviqPP$`
z$9^&=xRmh~T}o{UNinu~g#VuSj#y
zt>+@TrNyZ-Z$q6+7t0DIqEKHvS$z;GJ$(E5^~!<<#ErMLLMT)QMPUP_wnLCLX2M4?
zG}on-(#;7a=lPXZPvyU_c+)Xsn9UylD`k&W1%D%*
zaJp<;OX`EwUC$oG<*H+s_;b}GXkeX~G3mS6C)Or;lm0Mnqi{=Br?Q8ZI&1u`rMBzB
z$tVQRPx+hWlPXMR=ajz@7M3=fypDedHg4K2yXxin^J7-M-0_Ehh7SR#>tDB?@<)QW
zL&HV=5jrk{6CkxF{y@G8b&pR-))(<7a>@A5wp+ztTUw1$fxhQNZ_(WlIX}xCfBQUU
z2HMclUY=OvZ$X5!Rd3e{SFlj2b?{^>G(S%Zz4@N-+&JKTSdEy23h;w?iZ2D{x;&l15lOVj84bj
zQpKr^HV()G@v_zN*IMZd$ajbSlIC
zR=ASJ*!=A6t2`rq_$aC
znhnoF*av%@K~0vDQmb&;_Usmm=lK{0Wa
zZ0AzP-`cdAh4A)BqGdBZp%cgjl5O9Rn;}a}OK?^Y?yB?7XW6#~-B{bZnSv
z6l55@<8Q?Cy$??B2P|9N`BJ1CdZN0yS9a5CG@zxn)tcvSXc2}kMsN-bDo}1!Iwv;z
zJ0VatB)bQ?6_Q`@FkxGrU+~|<)F2#))1Fv%K;j6aG6Z>(Yc7R2n)e~Uj09EZeXAhga12{$ZL|bWaIs+3OuI^9
zNEeCBOy4@Iez|k1J?C!}mH?^;DMC6DdxnJ;K89$)vVh_{&=I7f1%n7|kgec#uEADy
zJ*C6w{1~mxhkp!{^q2Yh26`xdcV2^fI=_M+o64LEh+mxYD)(LMjPrZk-t;xx
zyuH<1My$0~Ko=gAP+8z1%(!&Hn)=Z5bH^D??BzfWpnUZ8N7}NdFhH~7LQLVF%v+cU
zaP|(?&28-^bAx378BCZJ1G*eM5?(IWMJwBAI5)GqFuW;sR|HA~B@RRC&``ie!M=!N`!D+W2WwRofpBRA9l@1Ip(MryBE{3
zyDME>M>c#Fa)3LiJU1INr#8OMnpV5#1n~L2nC$YaDL9-v~zZ)sX
zSoEU)cPoZEwdDLY{rEaAb-gKFg1?Ah(hs};5-GsjKWl*P<9Qq!p
z^PyDK-zAAX5y7M%cF#u2F-N`FJ(-T(FYh=X!sV(rrNn+Uf=NH@emhc*IqJpk
zN${B>v88m0Et8EU#OO-{&bd_VZaInlb_C6SsQ*c%9AnXo`tvJ>I<@3HO+S7WckJAh
z68pmlCjGGcACYp*Q7?9%1)nJryOb`mS0J&}l0(;wIbTV|?v|6-ja#y<9)=?27>i!i
z|MiNYPAxff=bH1QRMg)kuV8lslYSCwM9MKoz1aP2I(8pTm)L8NSZc|kTf3YQoI6j}
z_FGP3pNOE@5B0|)--?tJoKR#Uwj@ss@y9X4&9Ex
zRa~fgGb$)bFYa@rkUeg|M}p2G4*%7y$8b+~2okRBW|%^R
zZm5lJ6n{Ad9T}z{s$>6N!EWarCes#4aK@Mf_+wSoVdw)
zLjoR%!40+1Eh_&l1qX@OpQn@y@rqTFU7E}ch*w{cA510wK81eC=Z{j#g?y%|!~+BJ
zX=zgj@&rAbFHEN_GlLRv$#PPP6lWRoRW$kBStNGy*=t-^$!G3x(FU%-6zNoRR>`Ep
z&vt7JUj@OfofRaLhGuqQ)q2AfeR_Z0(suXOY|i>!DdoaZSR*I4^~X;={d|~0^+3G5
zJ()p2pF9>`_JipP$0@FJBD>*sx{;erK}5>$bV|7pxmZ0Nzkb|q$R@44T|1S6gT(7Z
zO1WgbCgSnB1?K@f1qX@Od`h`wywXF(o$tlP;G+R_wue-$Q;@49k
zmqYVm!vEq@k#gLqUpng!S*Fuq0Xkc1pR-te;n`%kSLZN-q50q~IX&`e91B5U*I*;6kjH
zWWsBORASTZ*__9XDdj>w(^TTpfO7Fu;le+Zg07Ud-6`e5QHZt4m*S;Od_z6i3f-{d
z9XO*m+)lRxe6CII=V|l8GFpst;3?Kh!Ci-9
zjqeESZ=|p!S^siMxy-CzRjkX88r@2+(zjA@ka+!vlyV_nu|_yO+(t@5K~;xhe94mX
zQ?k_i?GF<-(DPbu0A1my+bJrCtX^lPJ
mKt7M_g#7K{>3Tgb>u(Al^WkWG+6@Q(gR}8;4@G+}|NjAJAqM;a
literal 0
HcmV?d00001
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
new file mode 100644
index 0000000..8348b2a
--- /dev/null
+++ b/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 8413d32a6f7e0a25c8494bee106b6a82
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/docs.rst.txt b/docs/build/html/_sources/docs.rst.txt
new file mode 100644
index 0000000..fbca3ee
--- /dev/null
+++ b/docs/build/html/_sources/docs.rst.txt
@@ -0,0 +1,168 @@
+Overview
+=================================================================================
+
+`genanki` allows you to programatically generate decks in Python 3 for Anki, a popular spaced-repetition flashcard
+program. Please see below for concepts and usage.
+
+*This library and its author(s) are not affiliated/associated with the main Anki project in any way.*
+
+[](https://github.com/kerrickstaley/genanki/actions/workflows/ci.yml)
+
+## Notes
+The basic unit in Anki is the `Note`, which contains a fact to memorize. `Note`s correspond to one or more `Card`s.
+
+Here's how you create a `Note`:
+
+```python
+my_note = genanki.Note(
+ model=my_model,
+ fields=['Capital of Argentina', 'Buenos Aires'])
+```
+
+You pass in a `Model`, discussed below, and a set of `fields` (encoded as HTML).
+
+## Models
+A `Model` defines the fields and cards for a type of `Note`. For example:
+
+```python
+my_model = genanki.Model(
+ 1607392319,
+ 'Simple Model',
+ fields=[
+ {'name': 'Question'},
+ {'name': 'Answer'},
+ ],
+ templates=[
+ {
+ 'name': 'Card 1',
+ 'qfmt': '{{Question}}',
+ 'afmt': '{{FrontSide}}
{{Answer}}',
+ },
+ ])
+```
+
+This note-type has two fields and one card. The card displays the `Question` field on the front and the `Question` and
+`Answer` fields on the back, separated by a `
`. You can also pass a `css` argument to `Model()` to supply custom
+CSS.
+
+You need to pass a `model_id` so that Anki can keep track of your model. It's important that you use a unique `model_id`
+for each `Model` you define. Use `import random; random.randrange(1 << 30, 1 << 31)` to generate a suitable model_id, and hardcode it
+into your `Model` definition.
+
+## Generating a Deck/Package
+To import your notes into Anki, you need to add them to a `Deck`:
+
+```python
+my_deck = genanki.Deck(
+ 2059400110,
+ 'Country Capitals')
+
+my_deck.add_note(my_note)
+```
+
+Once again, you need a unique `deck_id` that you should generate once and then hardcode into your `.py` file.
+
+Then, create a `Package` for your `Deck` and write it to a file:
+
+```python
+genanki.Package(my_deck).write_to_file('output.apkg')
+```
+
+You can then load `output.apkg` into Anki using File -> Import...
+
+## Media Files
+To add sounds or images, set the `media_files` attribute on your `Package`:
+
+```python
+my_package = genanki.Package(my_deck)
+my_package.media_files = ['sound.mp3', 'images/image.jpg']
+```
+
+`media_files` should have the path (relative or absolute) to each file. To use them in notes, first add a field to your model, and reference that field in your template:
+
+```python
+my_model = genanki.Model(
+ 1091735104,
+ 'Simple Model with Media',
+ fields=[
+ {'name': 'Question'},
+ {'name': 'Answer'},
+ {'name': 'MyMedia'}, # ADD THIS
+ ],
+ templates=[
+ {
+ 'name': 'Card 1',
+ 'qfmt': '{{Question}}
{{MyMedia}}', # AND THIS
+ 'afmt': '{{FrontSide}}
{{Answer}}',
+ },
+ ])
+```
+
+Then, set the `MyMedia` field on your card to `[sound:sound.mp3]` for audio and `
` for images.
+
+You *cannot* put `
` in the template and `image.jpg` in the field. See these sections in the Anki manual for more information: [Importing Media](https://docs.ankiweb.net/#/importing?id=importing-media) and [Media & LaTeX](https://docs.ankiweb.net/#/templates/fields?id=media-amp-latex).
+
+You should only put the filename (aka basename) and not the full path in the field; `
` will *not* work. Media files should have unique filenames.
+
+## Note GUIDs
+`Note`s have a `guid` property that uniquely identifies the note. If you import a new note that has the same GUID as an
+existing note, the new note will overwrite the old one (as long as their models have the same fields).
+
+This is an important feature if you want to be able to tweak the design/content of your notes, regenerate your deck, and
+import the updated version into Anki. Your notes need to have stable GUIDs in order for the new note to replace the
+existing one.
+
+By default, the GUID is a hash of all the field values. This may not be desirable if, for example, you add a new field
+with additional info that doesn't change the identity of the note. You can create a custom GUID implementation to hash
+only the fields that identify the note:
+
+```python
+class MyNote(genanki.Note):
+ @property
+ def guid(self):
+ return genanki.guid_for(self.fields[0], self.fields[1])
+```
+
+## sort_field
+Anki has a value for each `Note` called the `sort_field`. Anki uses this value to sort the cards in the Browse
+interface. Anki also is happier if you avoid having two notes with the same `sort_field`, although this isn't strictly
+necessary. By default, the `sort_field` is the first field, but you can change it by passing `sort_field=` to `Note()`
+or implementing `sort_field` as a property in a subclass (similar to `guid`).
+
+You can also pass `sort_field_index=` to `Model()` to change the sort field. `0` means the first field in the Note, `1` means the second, etc.
+
+## YAML for Templates (and Fields)
+You can create your template definitions in the YAML format and pass them as a `str` to `Model()`. You can also do this
+for fields.
+
+## Using genanki inside an Anki addon
+`genanki` supports adding generated notes to the local collection when running inside an Anki 2.1 addon (Anki 2.0
+may work but has not been tested). See the [`.write_to_collection_from_addon() method`](
+https://github.com/kerrickstaley/genanki/blob/0c2cf8fea9c5e382e2fae9cd6d5eb440e267c637/genanki/__init__.py#L275).
+
+## FAQ
+### My field data is getting garbled
+If fields in your notes contain literal `<`, `>`, or `&` characters, you need to HTML-encode them: field data is HTML, not plain text. You can use the [`html.escape`](https://docs.python.org/3/library/html.html#html.escape) function.
+
+For example, you should write
+```
+fields=['AT&T was originally called', 'Bell Telephone Company']
+```
+or
+```
+fields=[html.escape(f) for f in ['AT&T was originally called', 'Bell Telephone Company']]
+```
+
+This applies even if the content is LaTeX; for example, you should write
+```
+fields=['Piketty calls this the "central contradiction of capitalism".', '[latex]r > g[/latex]']
+```
+
+## Publishing to PyPI
+If your name is Kerrick, you can publish the `genanki` package to PyPI by running these commands from the root of the `genanki` repo:
+```
+rm -rf dist/*
+python3 setup.py sdist bdist_wheel
+python3 -m twine upload dist/*
+```
+Note that this directly uploads to prod PyPI and skips uploading to test PyPI.
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
new file mode 100644
index 0000000..6a5de35
--- /dev/null
+++ b/docs/build/html/_sources/index.rst.txt
@@ -0,0 +1,13 @@
+.. genanki documentation master file, created by
+ sphinx-quickstart on Sat Jun 12 11:49:56 2021.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to genanki's documentation!
+===================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ overview
diff --git a/docs/build/html/_sources/overview.rst.txt b/docs/build/html/_sources/overview.rst.txt
new file mode 100644
index 0000000..fbca3ee
--- /dev/null
+++ b/docs/build/html/_sources/overview.rst.txt
@@ -0,0 +1,168 @@
+Overview
+=================================================================================
+
+`genanki` allows you to programatically generate decks in Python 3 for Anki, a popular spaced-repetition flashcard
+program. Please see below for concepts and usage.
+
+*This library and its author(s) are not affiliated/associated with the main Anki project in any way.*
+
+[](https://github.com/kerrickstaley/genanki/actions/workflows/ci.yml)
+
+## Notes
+The basic unit in Anki is the `Note`, which contains a fact to memorize. `Note`s correspond to one or more `Card`s.
+
+Here's how you create a `Note`:
+
+```python
+my_note = genanki.Note(
+ model=my_model,
+ fields=['Capital of Argentina', 'Buenos Aires'])
+```
+
+You pass in a `Model`, discussed below, and a set of `fields` (encoded as HTML).
+
+## Models
+A `Model` defines the fields and cards for a type of `Note`. For example:
+
+```python
+my_model = genanki.Model(
+ 1607392319,
+ 'Simple Model',
+ fields=[
+ {'name': 'Question'},
+ {'name': 'Answer'},
+ ],
+ templates=[
+ {
+ 'name': 'Card 1',
+ 'qfmt': '{{Question}}',
+ 'afmt': '{{FrontSide}}
{{Answer}}',
+ },
+ ])
+```
+
+This note-type has two fields and one card. The card displays the `Question` field on the front and the `Question` and
+`Answer` fields on the back, separated by a `
`. You can also pass a `css` argument to `Model()` to supply custom
+CSS.
+
+You need to pass a `model_id` so that Anki can keep track of your model. It's important that you use a unique `model_id`
+for each `Model` you define. Use `import random; random.randrange(1 << 30, 1 << 31)` to generate a suitable model_id, and hardcode it
+into your `Model` definition.
+
+## Generating a Deck/Package
+To import your notes into Anki, you need to add them to a `Deck`:
+
+```python
+my_deck = genanki.Deck(
+ 2059400110,
+ 'Country Capitals')
+
+my_deck.add_note(my_note)
+```
+
+Once again, you need a unique `deck_id` that you should generate once and then hardcode into your `.py` file.
+
+Then, create a `Package` for your `Deck` and write it to a file:
+
+```python
+genanki.Package(my_deck).write_to_file('output.apkg')
+```
+
+You can then load `output.apkg` into Anki using File -> Import...
+
+## Media Files
+To add sounds or images, set the `media_files` attribute on your `Package`:
+
+```python
+my_package = genanki.Package(my_deck)
+my_package.media_files = ['sound.mp3', 'images/image.jpg']
+```
+
+`media_files` should have the path (relative or absolute) to each file. To use them in notes, first add a field to your model, and reference that field in your template:
+
+```python
+my_model = genanki.Model(
+ 1091735104,
+ 'Simple Model with Media',
+ fields=[
+ {'name': 'Question'},
+ {'name': 'Answer'},
+ {'name': 'MyMedia'}, # ADD THIS
+ ],
+ templates=[
+ {
+ 'name': 'Card 1',
+ 'qfmt': '{{Question}}
{{MyMedia}}', # AND THIS
+ 'afmt': '{{FrontSide}}
{{Answer}}',
+ },
+ ])
+```
+
+Then, set the `MyMedia` field on your card to `[sound:sound.mp3]` for audio and `
` for images.
+
+You *cannot* put `
` in the template and `image.jpg` in the field. See these sections in the Anki manual for more information: [Importing Media](https://docs.ankiweb.net/#/importing?id=importing-media) and [Media & LaTeX](https://docs.ankiweb.net/#/templates/fields?id=media-amp-latex).
+
+You should only put the filename (aka basename) and not the full path in the field; `
` will *not* work. Media files should have unique filenames.
+
+## Note GUIDs
+`Note`s have a `guid` property that uniquely identifies the note. If you import a new note that has the same GUID as an
+existing note, the new note will overwrite the old one (as long as their models have the same fields).
+
+This is an important feature if you want to be able to tweak the design/content of your notes, regenerate your deck, and
+import the updated version into Anki. Your notes need to have stable GUIDs in order for the new note to replace the
+existing one.
+
+By default, the GUID is a hash of all the field values. This may not be desirable if, for example, you add a new field
+with additional info that doesn't change the identity of the note. You can create a custom GUID implementation to hash
+only the fields that identify the note:
+
+```python
+class MyNote(genanki.Note):
+ @property
+ def guid(self):
+ return genanki.guid_for(self.fields[0], self.fields[1])
+```
+
+## sort_field
+Anki has a value for each `Note` called the `sort_field`. Anki uses this value to sort the cards in the Browse
+interface. Anki also is happier if you avoid having two notes with the same `sort_field`, although this isn't strictly
+necessary. By default, the `sort_field` is the first field, but you can change it by passing `sort_field=` to `Note()`
+or implementing `sort_field` as a property in a subclass (similar to `guid`).
+
+You can also pass `sort_field_index=` to `Model()` to change the sort field. `0` means the first field in the Note, `1` means the second, etc.
+
+## YAML for Templates (and Fields)
+You can create your template definitions in the YAML format and pass them as a `str` to `Model()`. You can also do this
+for fields.
+
+## Using genanki inside an Anki addon
+`genanki` supports adding generated notes to the local collection when running inside an Anki 2.1 addon (Anki 2.0
+may work but has not been tested). See the [`.write_to_collection_from_addon() method`](
+https://github.com/kerrickstaley/genanki/blob/0c2cf8fea9c5e382e2fae9cd6d5eb440e267c637/genanki/__init__.py#L275).
+
+## FAQ
+### My field data is getting garbled
+If fields in your notes contain literal `<`, `>`, or `&` characters, you need to HTML-encode them: field data is HTML, not plain text. You can use the [`html.escape`](https://docs.python.org/3/library/html.html#html.escape) function.
+
+For example, you should write
+```
+fields=['AT&T was originally called', 'Bell Telephone Company']
+```
+or
+```
+fields=[html.escape(f) for f in ['AT&T was originally called', 'Bell Telephone Company']]
+```
+
+This applies even if the content is LaTeX; for example, you should write
+```
+fields=['Piketty calls this the "central contradiction of capitalism".', '[latex]r > g[/latex]']
+```
+
+## Publishing to PyPI
+If your name is Kerrick, you can publish the `genanki` package to PyPI by running these commands from the root of the `genanki` repo:
+```
+rm -rf dist/*
+python3 setup.py sdist bdist_wheel
+python3 -m twine upload dist/*
+```
+Note that this directly uploads to prod PyPI and skips uploading to test PyPI.
diff --git a/docs/build/html/_static/alabaster.css b/docs/build/html/_static/alabaster.css
new file mode 100644
index 0000000..0eddaeb
--- /dev/null
+++ b/docs/build/html/_static/alabaster.css
@@ -0,0 +1,701 @@
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: Georgia, serif;
+ font-size: 17px;
+ background-color: #fff;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+
+div.document {
+ width: 940px;
+ margin: 30px auto 0 auto;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 220px;
+}
+
+div.sphinxsidebar {
+ width: 220px;
+ font-size: 14px;
+ line-height: 1.5;
+}
+
+hr {
+ border: 1px solid #B1B4B6;
+}
+
+div.body {
+ background-color: #fff;
+ color: #3E4349;
+ padding: 0 30px 0 30px;
+}
+
+div.body > .section {
+ text-align: left;
+}
+
+div.footer {
+ width: 940px;
+ margin: 20px auto 30px auto;
+ font-size: 14px;
+ color: #888;
+ text-align: right;
+}
+
+div.footer a {
+ color: #888;
+}
+
+p.caption {
+ font-family: inherit;
+ font-size: inherit;
+}
+
+
+div.relations {
+ display: none;
+}
+
+
+div.sphinxsidebar a {
+ color: #444;
+ text-decoration: none;
+ border-bottom: 1px dotted #999;
+}
+
+div.sphinxsidebar a:hover {
+ border-bottom: 1px solid #999;
+}
+
+div.sphinxsidebarwrapper {
+ padding: 18px 10px;
+}
+
+div.sphinxsidebarwrapper p.logo {
+ padding: 0;
+ margin: -10px 0 0 0px;
+ text-align: center;
+}
+
+div.sphinxsidebarwrapper h1.logo {
+ margin-top: -10px;
+ text-align: center;
+ margin-bottom: 5px;
+ text-align: left;
+}
+
+div.sphinxsidebarwrapper h1.logo-name {
+ margin-top: 0px;
+}
+
+div.sphinxsidebarwrapper p.blurb {
+ margin-top: 0;
+ font-style: normal;
+}
+
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+ font-family: Georgia, serif;
+ color: #444;
+ font-size: 24px;
+ font-weight: normal;
+ margin: 0 0 5px 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h4 {
+ font-size: 20px;
+}
+
+div.sphinxsidebar h3 a {
+ color: #444;
+}
+
+div.sphinxsidebar p.logo a,
+div.sphinxsidebar h3 a,
+div.sphinxsidebar p.logo a:hover,
+div.sphinxsidebar h3 a:hover {
+ border: none;
+}
+
+div.sphinxsidebar p {
+ color: #555;
+ margin: 10px 0;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px 0;
+ padding: 0;
+ color: #000;
+}
+
+div.sphinxsidebar ul li.toctree-l1 > a {
+ font-size: 120%;
+}
+
+div.sphinxsidebar ul li.toctree-l2 > a {
+ font-size: 110%;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #CCC;
+ font-family: Georgia, serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar hr {
+ border: none;
+ height: 1px;
+ color: #AAA;
+ background: #AAA;
+
+ text-align: left;
+ margin-left: 0;
+ width: 50%;
+}
+
+div.sphinxsidebar .badge {
+ border-bottom: none;
+}
+
+div.sphinxsidebar .badge:hover {
+ border-bottom: none;
+}
+
+/* To address an issue with donation coming after search */
+div.sphinxsidebar h3.donation {
+ margin-top: 10px;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: #004B6B;
+ text-decoration: underline;
+}
+
+a:hover {
+ color: #6D4100;
+ text-decoration: underline;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: Georgia, serif;
+ font-weight: normal;
+ margin: 30px 0px 10px 0px;
+ padding: 0;
+}
+
+div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: #DDD;
+ padding: 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ color: #444;
+ background: #EAEAEA;
+}
+
+div.body p, div.body dd, div.body li {
+ line-height: 1.4em;
+}
+
+div.admonition {
+ margin: 20px 0px;
+ padding: 10px 30px;
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+ background-color: #FBFBFB;
+ border-bottom: 1px solid #fafafa;
+}
+
+div.admonition p.admonition-title {
+ font-family: Georgia, serif;
+ font-weight: normal;
+ font-size: 24px;
+ margin: 0 0 10px 0;
+ padding: 0;
+ line-height: 1;
+}
+
+div.admonition p.last {
+ margin-bottom: 0;
+}
+
+div.highlight {
+ background-color: #fff;
+}
+
+dt:target, .highlight {
+ background: #FAF3E8;
+}
+
+div.warning {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.danger {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.error {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.caution {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.attention {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.important {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.note {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.tip {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.hint {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.seealso {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.topic {
+ background-color: #EEE;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre, tt, code {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.9em;
+}
+
+.hll {
+ background-color: #FFC;
+ margin: 0 -12px;
+ padding: 0 12px;
+ display: block;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname, code.descname, code.descclassname {
+ font-size: 0.95em;
+}
+
+tt.descname, code.descname {
+ padding-right: 0.08em;
+}
+
+img.screenshot {
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils {
+ border: 1px solid #888;
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils td, table.docutils th {
+ border: 1px solid #888;
+ padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+ border: none;
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+table.footnote {
+ margin: 15px 0;
+ width: 100%;
+ border: 1px solid #EEE;
+ background: #FDFDFD;
+ font-size: 0.9em;
+}
+
+table.footnote + table.footnote {
+ margin-top: -15px;
+ border-top: none;
+}
+
+table.field-list th {
+ padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+ padding: 0;
+}
+
+table.field-list p {
+ margin-bottom: 0.8em;
+}
+
+/* Cloned from
+ * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
+ */
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+table.footnote td.label {
+ width: .1px;
+ padding: 0.3em 0 0.3em 0.5em;
+}
+
+table.footnote td {
+ padding: 0.3em 0.5em;
+}
+
+dl {
+ margin: 0;
+ padding: 0;
+}
+
+dl dd {
+ margin-left: 30px;
+}
+
+blockquote {
+ margin: 0 0 0 30px;
+ padding: 0;
+}
+
+ul, ol {
+ /* Matches the 30px from the narrow-screen "li > ul" selector below */
+ margin: 10px 0 10px 30px;
+ padding: 0;
+}
+
+pre {
+ background: #EEE;
+ padding: 7px 30px;
+ margin: 15px 0px;
+ line-height: 1.3em;
+}
+
+div.viewcode-block:target {
+ background: #ffd;
+}
+
+dl pre, blockquote pre, li pre {
+ margin-left: 0;
+ padding-left: 30px;
+}
+
+tt, code {
+ background-color: #ecf0f3;
+ color: #222;
+ /* padding: 1px 2px; */
+}
+
+tt.xref, code.xref, a tt {
+ background-color: #FBFBFB;
+ border-bottom: 1px solid #fff;
+}
+
+a.reference {
+ text-decoration: none;
+ border-bottom: 1px dotted #004B6B;
+}
+
+/* Don't put an underline on images */
+a.image-reference, a.image-reference:hover {
+ border-bottom: none;
+}
+
+a.reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
+a.footnote-reference {
+ text-decoration: none;
+ font-size: 0.7em;
+ vertical-align: top;
+ border-bottom: 1px dotted #004B6B;
+}
+
+a.footnote-reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
+a:hover tt, a:hover code {
+ background: #EEE;
+}
+
+
+@media screen and (max-width: 870px) {
+
+ div.sphinxsidebar {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+
+ }
+
+ div.documentwrapper {
+ margin-left: 0;
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ }
+
+ div.bodywrapper {
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ margin-left: 0;
+ }
+
+ ul {
+ margin-left: 0;
+ }
+
+ li > ul {
+ /* Matches the 30px from the "ul, ol" selector above */
+ margin-left: 30px;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .bodywrapper {
+ margin: 0;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+
+
+
+}
+
+
+
+@media screen and (max-width: 875px) {
+
+ body {
+ margin: 0;
+ padding: 20px 30px;
+ }
+
+ div.documentwrapper {
+ float: none;
+ background: #fff;
+ }
+
+ div.sphinxsidebar {
+ display: block;
+ float: none;
+ width: 102.5%;
+ margin: 50px -30px -20px -30px;
+ padding: 10px 20px;
+ background: #333;
+ color: #FFF;
+ }
+
+ div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
+ div.sphinxsidebar h3 a {
+ color: #fff;
+ }
+
+ div.sphinxsidebar a {
+ color: #AAA;
+ }
+
+ div.sphinxsidebar p.logo {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+ margin: 0;
+ }
+
+ div.footer {
+ display: none;
+ }
+
+ div.bodywrapper {
+ margin: 0;
+ }
+
+ div.body {
+ min-height: 0;
+ padding: 0;
+ }
+
+ .rtd_doc_footer {
+ display: none;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+}
+
+
+/* misc. */
+
+.revsys-inline {
+ display: none!important;
+}
+
+/* Make nested-list/multi-paragraph items look better in Releases changelog
+ * pages. Without this, docutils' magical list fuckery causes inconsistent
+ * formatting between different release sub-lists.
+ */
+div#changelog > div.section > ul > li > p:only-child {
+ margin-bottom: 0;
+}
+
+/* Hide fugly table cell borders in ..bibliography:: directive output */
+table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
+ border: none;
+ /* Below needed in some edge cases; if not applied, bottom shadows appear */
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+
+/* relbar */
+
+.related {
+ line-height: 30px;
+ width: 100%;
+ font-size: 0.9rem;
+}
+
+.related.top {
+ border-bottom: 1px solid #EEE;
+ margin-bottom: 20px;
+}
+
+.related.bottom {
+ border-top: 1px solid #EEE;
+}
+
+.related ul {
+ padding: 0;
+ margin: 0;
+ list-style: none;
+}
+
+.related li {
+ display: inline;
+}
+
+nav#rellinks {
+ float: right;
+}
+
+nav#rellinks li+li:before {
+ content: "|";
+}
+
+nav#breadcrumbs li+li:before {
+ content: "\00BB";
+}
+
+/* Hide certain items when printing */
+@media print {
+ div.related {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css
new file mode 100644
index 0000000..56f5efc
--- /dev/null
+++ b/docs/build/html/_static/basic.css
@@ -0,0 +1,835 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+ overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ float: left;
+ width: 80%;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+ float: left;
+ width: 20%;
+ border-left: none;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+
+img {
+ border: 0;
+ max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li div.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+ width: 100%;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable ul {
+ margin-top: 0;
+ margin-bottom: 0;
+ list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+ padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+div.modindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+ padding: 2px;
+ border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+ min-width: 450px;
+ max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
+a.headerlink {
+ visibility: hidden;
+}
+
+a.brackets:before,
+span.brackets > a:before{
+ content: "[";
+}
+
+a.brackets:after,
+span.brackets > a:after {
+ content: "]";
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+img.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+img.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left;
+}
+
+.align-center {
+ text-align: center;
+}
+
+.align-default {
+ text-align: center;
+}
+
+.align-right {
+ text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+ clear: right;
+ overflow-x: auto;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+div.admonition, div.topic, pre, div[class|="highlight"] {
+ clear: both;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px;
+ margin: 10px 0 10px 0;
+ overflow-x: auto;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+ overflow-x: auto;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+ margin-bottom: 0;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table caption span.caption-number {
+ font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+table.footnote td, table.footnote th {
+ border: 0 !important;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px;
+}
+
+table.citation td {
+ border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+ margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+ margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure {
+ margin: 0.5em;
+ padding: 0.5em;
+}
+
+div.figure p.caption {
+ padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number {
+ font-style: italic;
+}
+
+div.figure p.caption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+ margin: 1em 0;
+}
+
+table.hlist td {
+ vertical-align: top;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+ list-style: decimal;
+}
+
+ol.loweralpha {
+ list-style: lower-alpha;
+}
+
+ol.upperalpha {
+ list-style: upper-alpha;
+}
+
+ol.lowerroman {
+ list-style: lower-roman;
+}
+
+ol.upperroman {
+ list-style: upper-roman;
+}
+
+ol > li:first-child > :first-child,
+ul > li:first-child > :first-child {
+ margin-top: 0px;
+}
+
+ol ol > li:first-child > :first-child,
+ol ul > li:first-child > :first-child,
+ul ol > li:first-child > :first-child,
+ul ul > li:first-child > :first-child {
+ margin-top: revert;
+}
+
+ol > li:last-child > :last-child,
+ul > li:last-child > :last-child {
+ margin-bottom: 0px;
+}
+
+ol ol > li:last-child > :last-child,
+ol ul > li:last-child > :last-child,
+ul ol > li:last-child > :last-child,
+ul ul > li:last-child > :last-child {
+ margin-bottom: revert;
+}
+
+dl.footnote > dt,
+dl.citation > dt {
+ float: left;
+ margin-right: 0.5em;
+}
+
+dl.footnote > dd,
+dl.citation > dd {
+ margin-bottom: 0em;
+}
+
+dl.footnote > dd:after,
+dl.citation > dd:after {
+ content: "";
+ clear: both;
+}
+
+dl.field-list {
+ display: grid;
+ grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+ font-weight: bold;
+ word-break: break-word;
+ padding-left: 0.5em;
+ padding-right: 5px;
+}
+
+dl.field-list > dt:after {
+ content: ":";
+}
+
+dl.field-list > dd {
+ padding-left: 0.5em;
+ margin-top: 0em;
+ margin-left: 0em;
+ margin-bottom: 0em;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd > :first-child {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+ margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+ background-color: #fbe54e;
+}
+
+rect.highlighted {
+ fill: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.sig-paren {
+ font-size: larger;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa;
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+ font-family: sans-serif;
+}
+
+.accelerator {
+ text-decoration: underline;
+}
+
+.classifier {
+ font-style: oblique;
+}
+
+.classifier:before {
+ font-style: normal;
+ margin: 0.5em;
+ content: ":";
+}
+
+abbr, acronym {
+ border-bottom: dotted 1px;
+ cursor: help;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
+}
+
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+}
+
+div[class^="highlight-"] {
+ margin: 1em 0;
+}
+
+td.linenos pre {
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ display: block;
+}
+
+table.highlighttable tbody {
+ display: block;
+}
+
+table.highlighttable tr {
+ display: flex;
+}
+
+table.highlighttable td {
+ margin: 0;
+ padding: 0;
+}
+
+table.highlighttable td.linenos {
+ padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+ flex: 1;
+ overflow: hidden;
+}
+
+.highlight .hll {
+ display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+ margin: 0;
+}
+
+div.code-block-caption + div {
+ margin-top: 0;
+}
+
+div.code-block-caption {
+ margin-top: 1em;
+ padding: 2px 5px;
+ font-size: small;
+}
+
+div.code-block-caption code {
+ background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
+ user-select: none;
+}
+
+div.code-block-caption span.caption-number {
+ padding: 0.1em 0.3em;
+ font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+ margin: 1em 0;
+}
+
+code.descname {
+ background-color: transparent;
+ font-weight: bold;
+ font-size: 1.2em;
+}
+
+code.descclassname {
+ background-color: transparent;
+}
+
+code.xref, a code {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ background-color: transparent;
+}
+
+.viewcode-link {
+ float: right;
+}
+
+.viewcode-back {
+ float: right;
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ margin: -1px -10px;
+ padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+span.eqno a.headerlink {
+ position: absolute;
+ z-index: 1;
+}
+
+div.math:hover a.headerlink {
+ visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/build/html/_static/custom.css b/docs/build/html/_static/custom.css
new file mode 100644
index 0000000..2a924f1
--- /dev/null
+++ b/docs/build/html/_static/custom.css
@@ -0,0 +1 @@
+/* This file intentionally left blank. */
diff --git a/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js
new file mode 100644
index 0000000..daccd20
--- /dev/null
+++ b/docs/build/html/_static/doctools.js
@@ -0,0 +1,315 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for all documentation.
+ *
+ * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+/**
+ * make the code below compatible with browsers without
+ * an installed firebug like debugger
+if (!window.console || !console.firebug) {
+ var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
+ "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
+ "profile", "profileEnd"];
+ window.console = {};
+ for (var i = 0; i < names.length; ++i)
+ window.console[names[i]] = function() {};
+}
+ */
+
+/**
+ * small helper function to urldecode strings
+ */
+jQuery.urldecode = function(x) {
+ return decodeURIComponent(x).replace(/\+/g, ' ');
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+ if (typeof s === 'undefined')
+ s = document.location.search;
+ var parts = s.substr(s.indexOf('?') + 1).split('&');
+ var result = {};
+ for (var i = 0; i < parts.length; i++) {
+ var tmp = parts[i].split('=', 2);
+ var key = jQuery.urldecode(tmp[0]);
+ var value = jQuery.urldecode(tmp[1]);
+ if (key in result)
+ result[key].push(value);
+ else
+ result[key] = [value];
+ }
+ return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+ function highlight(node, addItems) {
+ if (node.nodeType === 3) {
+ var val = node.nodeValue;
+ var pos = val.toLowerCase().indexOf(text);
+ if (pos >= 0 &&
+ !jQuery(node.parentNode).hasClass(className) &&
+ !jQuery(node.parentNode).hasClass("nohighlight")) {
+ var span;
+ var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.className = className;
+ }
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+ document.createTextNode(val.substr(pos + text.length)),
+ node.nextSibling));
+ node.nodeValue = val.substr(0, pos);
+ if (isInSVG) {
+ var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+ var bbox = node.parentElement.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute('class', className);
+ addItems.push({
+ "parent": node.parentNode,
+ "target": rect});
+ }
+ }
+ }
+ else if (!jQuery(node).is("button, select, textarea")) {
+ jQuery.each(node.childNodes, function() {
+ highlight(this, addItems);
+ });
+ }
+ }
+ var addItems = [];
+ var result = this.each(function() {
+ highlight(this, addItems);
+ });
+ for (var i = 0; i < addItems.length; ++i) {
+ jQuery(addItems[i].parent).before(addItems[i].target);
+ }
+ return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+ jQuery.uaMatch = function(ua) {
+ ua = ua.toLowerCase();
+
+ var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+ /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+ /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+ /(msie) ([\w.]+)/.exec(ua) ||
+ ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+ [];
+
+ return {
+ browser: match[ 1 ] || "",
+ version: match[ 2 ] || "0"
+ };
+ };
+ jQuery.browser = {};
+ jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+var Documentation = {
+
+ init : function() {
+ this.fixFirefoxAnchorBug();
+ this.highlightSearchWords();
+ this.initIndexTable();
+ if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
+ this.initOnKeyListeners();
+ }
+ },
+
+ /**
+ * i18n support
+ */
+ TRANSLATIONS : {},
+ PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
+ LOCALE : 'unknown',
+
+ // gettext and ngettext don't access this so that the functions
+ // can safely bound to a different name (_ = Documentation.gettext)
+ gettext : function(string) {
+ var translated = Documentation.TRANSLATIONS[string];
+ if (typeof translated === 'undefined')
+ return string;
+ return (typeof translated === 'string') ? translated : translated[0];
+ },
+
+ ngettext : function(singular, plural, n) {
+ var translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated === 'undefined')
+ return (n == 1) ? singular : plural;
+ return translated[Documentation.PLURALEXPR(n)];
+ },
+
+ addTranslations : function(catalog) {
+ for (var key in catalog.messages)
+ this.TRANSLATIONS[key] = catalog.messages[key];
+ this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
+ this.LOCALE = catalog.locale;
+ },
+
+ /**
+ * add context elements like header anchor links
+ */
+ addContextElements : function() {
+ $('div[id] > :header:first').each(function() {
+ $('').
+ attr('href', '#' + this.id).
+ attr('title', _('Permalink to this headline')).
+ appendTo(this);
+ });
+ $('dt[id]').each(function() {
+ $('').
+ attr('href', '#' + this.id).
+ attr('title', _('Permalink to this definition')).
+ appendTo(this);
+ });
+ },
+
+ /**
+ * workaround a firefox stupidity
+ * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
+ */
+ fixFirefoxAnchorBug : function() {
+ if (document.location.hash && $.browser.mozilla)
+ window.setTimeout(function() {
+ document.location.href += '';
+ }, 10);
+ },
+
+ /**
+ * highlight the search words provided in the url in the text
+ */
+ highlightSearchWords : function() {
+ var params = $.getQueryParameters();
+ var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
+ if (terms.length) {
+ var body = $('div.body');
+ if (!body.length) {
+ body = $('body');
+ }
+ window.setTimeout(function() {
+ $.each(terms, function() {
+ body.highlightText(this.toLowerCase(), 'highlighted');
+ });
+ }, 10);
+ $('' + _('Hide Search Matches') + '
')
+ .appendTo($('#searchbox'));
+ }
+ },
+
+ /**
+ * init the domain index toggle buttons
+ */
+ initIndexTable : function() {
+ var togglers = $('img.toggler').click(function() {
+ var src = $(this).attr('src');
+ var idnum = $(this).attr('id').substr(7);
+ $('tr.cg-' + idnum).toggle();
+ if (src.substr(-9) === 'minus.png')
+ $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
+ else
+ $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
+ }).css('display', '');
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
+ togglers.click();
+ }
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords : function() {
+ $('#searchbox .highlight-link').fadeOut(300);
+ $('span.highlighted').removeClass('highlighted');
+ },
+
+ /**
+ * make the url absolute
+ */
+ makeURL : function(relativeURL) {
+ return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
+ },
+
+ /**
+ * get the current relative url
+ */
+ getCurrentURL : function() {
+ var path = document.location.pathname;
+ var parts = path.split(/\//);
+ $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
+ if (this === '..')
+ parts.pop();
+ });
+ var url = parts.join('/');
+ return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+ },
+
+ initOnKeyListeners: function() {
+ $(document).keydown(function(event) {
+ var activeElementType = document.activeElement.tagName;
+ // don't navigate when in search box or textarea
+ if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
+ && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
+ switch (event.keyCode) {
+ case 37: // left
+ var prevHref = $('link[rel="prev"]').prop('href');
+ if (prevHref) {
+ window.location.href = prevHref;
+ return false;
+ }
+ case 39: // right
+ var nextHref = $('link[rel="next"]').prop('href');
+ if (nextHref) {
+ window.location.href = nextHref;
+ return false;
+ }
+ }
+ }
+ });
+ }
+};
+
+// quick alias for translations
+_ = Documentation.gettext;
+
+$(document).ready(function() {
+ Documentation.init();
+});
diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
new file mode 100644
index 0000000..8839ac8
--- /dev/null
+++ b/docs/build/html/_static/documentation_options.js
@@ -0,0 +1,12 @@
+var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+ VERSION: '0.1',
+ LANGUAGE: 'None',
+ COLLAPSE_INDEX: false,
+ BUILDER: 'html',
+ FILE_SUFFIX: '.html',
+ LINK_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt',
+ NAVIGATION_WITH_KEYS: false
+};
\ No newline at end of file
diff --git a/docs/build/html/_static/file.png b/docs/build/html/_static/file.png
new file mode 100644
index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3
GIT binary patch
literal 286
zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1
z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8(
literal 0
HcmV?d00001
diff --git a/docs/build/html/_static/jquery-3.5.1.js b/docs/build/html/_static/jquery-3.5.1.js
new file mode 100644
index 0000000..5093733
--- /dev/null
+++ b/docs/build/html/_static/jquery-3.5.1.js
@@ -0,0 +1,10872 @@
+/*!
+ * jQuery JavaScript Library v3.5.1
+ * https://jquery.com/
+ *
+ * Includes Sizzle.js
+ * https://sizzlejs.com/
+ *
+ * Copyright JS Foundation and other contributors
+ * Released under the MIT license
+ * https://jquery.org/license
+ *
+ * Date: 2020-05-04T22:49Z
+ */
+( function( global, factory ) {
+
+ "use strict";
+
+ if ( typeof module === "object" && typeof module.exports === "object" ) {
+
+ // For CommonJS and CommonJS-like environments where a proper `window`
+ // is present, execute the factory and get jQuery.
+ // For environments that do not have a `window` with a `document`
+ // (such as Node.js), expose a factory as module.exports.
+ // This accentuates the need for the creation of a real `window`.
+ // e.g. var jQuery = require("jquery")(window);
+ // See ticket #14549 for more info.
+ module.exports = global.document ?
+ factory( global, true ) :
+ function( w ) {
+ if ( !w.document ) {
+ throw new Error( "jQuery requires a window with a document" );
+ }
+ return factory( w );
+ };
+ } else {
+ factory( global );
+ }
+
+// Pass this if window is not defined yet
+} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
+
+// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
+// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
+// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
+// enough that all such attempts are guarded in a try block.
+"use strict";
+
+var arr = [];
+
+var getProto = Object.getPrototypeOf;
+
+var slice = arr.slice;
+
+var flat = arr.flat ? function( array ) {
+ return arr.flat.call( array );
+} : function( array ) {
+ return arr.concat.apply( [], array );
+};
+
+
+var push = arr.push;
+
+var indexOf = arr.indexOf;
+
+var class2type = {};
+
+var toString = class2type.toString;
+
+var hasOwn = class2type.hasOwnProperty;
+
+var fnToString = hasOwn.toString;
+
+var ObjectFunctionString = fnToString.call( Object );
+
+var support = {};
+
+var isFunction = function isFunction( obj ) {
+
+ // Support: Chrome <=57, Firefox <=52
+ // In some browsers, typeof returns "function" for HTML