update docs

essicolo · essicolo · commit 3e09aebfd2b8 · 2024-09-26T18:14:08.000-04:00
diff --git a/docs/_images/logo.png b/docs/_images/logo.png
diff --git a/docs/_images/logo.svg b/docs/_images/logo.svg
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="49.355896mm"
+   height="52.902878mm"
+   viewBox="0 0 49.355896 52.902878"
+   version="1.1"
+   id="svg1"
+   xml:space="preserve"
+   inkscape:version="1.3 (0e150ed6c4, 2023-07-21)"
+   sodipodi:docname="logo.svg"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"><sodipodi:namedview
+     id="namedview1"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:document-units="mm"
+     inkscape:zoom="2"
+     inkscape:cx="128.25"
+     inkscape:cy="138.25"
+     inkscape:window-width="1920"
+     inkscape:window-height="1017"
+     inkscape:window-x="-8"
+     inkscape:window-y="352"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="layer1" /><defs
+     id="defs1" /><g
+     inkscape:label="Calque 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-29.075734,-181.62505)"><path
+       style="fill:#ffffff;stroke-width:0"
+       d="m 41.987063,190.44325 c -4.324761,3.42807 -4.527418,7.86777 -4.562497,8.8266 -0.03508,0.95883 1.356393,6.40779 1.765649,6.99244 0.409256,0.58465 3.016805,3.81193 3.578071,3.83532 0.561266,0.0234 6.080381,1.91766 6.793657,1.8358 0.713276,-0.0819 3.55103,0.32315 5.039701,-0.46772 1.48867,-0.79086 -0.572959,3.57807 -0.572959,3.57807 l -4.513514,1.61364 -4.279653,4.32643 -3.835318,4.60706 -4.794147,-0.98222 -4.513514,-2.47892 -1.847501,1.07576 -0.664942,1.30684 -0.01654,1.87689 0.239778,3.86953 0.517705,1.31311 1.543481,1.77734 10.671887,-2.14787 16.767968,0.69453 7.639844,-0.0661 4.431771,-0.72761 4.299479,0.89297 1.470356,-1.24758 0.643117,-3.30913 0.08185,-3.57807 0.07016,-1.90597 -1.485017,-2.04628 -1.640361,0.54458 -1.703255,2.21589 c 0,0 -2.42269,0.74264 -3.181101,0.8176 -0.758411,0.075 -0.912056,0.3274 -1.286235,-0.0702 -0.374176,-0.39756 -1.608622,-2.07214 -1.608622,-2.07214 l 1.936028,-2.97925 -5.715799,-10.28804 0.181901,-1.11765 0.550881,-0.46453 c 0,0 1.670301,-0.83487 2.180741,-2.22312 0.510439,-1.38825 0.47281,-2.31544 0.47281,-2.31544 l -1.11257,-5.88616 -2.852539,-5.88698 -6.680729,-4.06797 -5.217253,-0.29766 -4.696354,1.31465 -3.844726,2.91042 z"
+       id="path5"
+       sodipodi:nodetypes="cssccccccccccccccccccccccccccczccccccscccccccc" /><path
+       id="path4"
+       style="fill:#000000"
+       d="m 59.180367,181.62612 c -1.147535,0.0232 -2.348435,0.42274 -3.443717,1.28261 -1.304245,1.02392 -1.937459,1.67396 -1.952853,2.09496 -0.437521,-0.0418 -0.902364,-0.0729 -1.465027,-0.0879 -2.015392,-0.0535 -3.394019,0.14577 -5.243607,0.75758 -0.558793,0.18484 -1.487276,0.66208 -2.494938,1.26659 l -2.153357,-1.07229 c -2.334461,-1.16222 -4.387049,-1.21611 -5.771224,-0.15141 -2.478884,1.90673 -2.497269,5.42355 -0.03824,7.34787 0.69279,0.54216 1.174211,0.86396 1.557528,0.94775 -0.104087,0.16714 -0.276469,0.44183 -0.276469,0.44183 0,0.0116 -0.112098,0.29069 -0.24908,0.62012 -0.337727,0.81217 -0.558009,1.55653 -0.748792,2.53111 -0.620338,3.16892 -0.07854,6.26299 1.56838,8.95915 0.178685,0.29253 0.325044,0.54315 0.325044,0.55655 0,0.0327 -0.888511,1.92052 -1.519287,3.22823 -2.379831,4.93378 -2.500689,5.19839 -2.840136,6.22959 -0.732,2.22373 -0.652891,4.22097 0.236678,5.98465 -0.383237,-0.63859 -1.168237,-1.40145 -1.744597,-1.6955 -0.868211,-0.44297 -1.28798,-0.28461 -2.447912,0.92552 -1.190989,1.24253 -1.400815,1.98311 -1.403015,4.95887 -0.003,3.67146 0.601625,5.6505 2.174544,7.11791 0.593598,0.55377 1.381094,0.77566 2.122351,0.5979 0.648194,-0.1554 2.398562,-0.55887 3.889685,-0.89659 1.416486,-0.32081 2.713652,-0.70019 3.001367,-0.87281 2.095125,0.13784 4.811152,0.23595 8.122502,0.28112 3.145342,0.0429 4.310491,0.0403 10.615373,-0.0233 5.464454,-0.0551 9.434755,-0.29272 11.226188,-0.65009 0.75831,0.13958 1.643437,0.37785 2.324406,0.64234 2.482392,0.96417 3.155729,0.81731 4.49895,-0.98237 0.901086,-1.2073 1.16572,-2.46004 1.312581,-6.20995 0.172047,-4.39109 0.09595,-4.7989 -1.173055,-6.25905 -1.120401,-1.28919 -1.527075,-1.4587 -2.328023,-0.96997 -0.990808,0.60456 -2.531721,3.40655 -4.242635,7.71529 -0.526728,1.32654 -1.393126,3.05245 -1.924947,3.83491 -0.263861,0.38823 -0.467391,0.70036 -0.61495,0.95705 -0.01751,-0.001 -0.02836,-0.003 -0.04599,-0.004 -0.395677,-0.0245 -0.719336,-0.0576 -0.719336,-0.0739 0,-0.0163 0.08117,-0.13488 0.180351,-0.26304 0.299171,-0.38658 0.440495,-0.65558 0.627352,-1.19217 0.159195,-0.45716 0.178083,-0.5962 0.175183,-1.31052 -0.0043,-1.05294 -0.0032,-1.04974 -1.79989,-5.02036 -0.554893,-1.22629 -1.610834,-3.59425 -2.134754,-4.78679 -0.136804,-0.31139 -0.331798,-0.68638 -0.433048,-0.83354 -0.280268,-0.40736 -0.849407,-0.66941 -1.813326,-0.83509 -0.242054,-0.0416 -0.241979,-0.0417 -0.153479,0.1695 0.180028,0.42954 2.853067,6.34563 3.880383,8.5881 0.833891,1.82026 0.917323,2.0903 0.881083,2.85306 -0.03763,0.79196 -0.257723,1.29901 -0.798917,1.83916 -0.447383,0.44652 -0.820336,0.67228 -1.326534,0.80409 -0.570376,0.14852 -8.707097,0.14852 -9.27747,0 -1.578732,-0.4111 -2.524222,-2.15162 -2.005563,-3.69125 0.07359,-0.21845 0.562433,-1.28335 1.086756,-2.36678 0.52432,-1.08344 0.95343,-1.98078 0.95343,-1.99368 0,-0.0129 0.288041,-0.61814 0.639754,-1.34513 0.351714,-0.72702 0.639238,-1.33158 0.639238,-1.34308 0,-0.0115 0.262255,-0.56274 0.58291,-1.22524 1.076123,-2.22338 0.951996,-1.52885 0.949296,-5.31958 l -0.0021,-3.30315 -0.266134,-0.12816 c -0.321935,-0.15471 -0.502346,-0.38709 -0.510046,-0.65732 -0.0108,-0.37974 0.04353,-0.3974 1.234033,-0.3974 1.051748,0 1.078591,-0.004 1.152901,-0.14417 0.116107,-0.21955 0.52481,-0.6667 0.934827,-1.02371 0.20286,-0.17663 0.378437,-0.34601 0.390157,-0.37621 0.03013,-0.0775 -3.225387,-0.0683 -3.639571,0.0103 -1.050403,0.1992 -1.679669,0.91488 -1.685169,1.91719 -0.0031,0.57279 0.138131,0.93278 0.535368,1.36374 l 0.26355,0.28577 -0.01809,2.80448 c -0.01782,2.78676 -0.01894,2.80626 -0.166915,3.11558 -0.0819,0.17121 -0.365234,0.76122 -0.629935,1.31103 -2.528928,5.25276 -3.895571,8.19702 -4.010608,8.64133 -0.16335,0.6309 -0.196178,1.42198 -0.08165,1.95905 0.131681,0.61751 0.324341,1.04268 0.724504,1.60042 l 0.336413,0.46923 h -0.652673 c -1.763974,-2.1e-4 -4.06345,-0.47367 -5.743836,-1.18236 -1.034925,-0.43648 -2.245029,-1.20375 -3.216341,-2.03967 l -0.377754,-0.32556 c -0.777301,-1.1857 -0.02791,-2.46807 -0.02791,-2.46807 1.290345,-0.8512 2.230475,-1.09072 3.820956,-1.08572 1.122977,-0.21977 2.135829,-0.72363 2.818432,-1.40198 0.79533,-0.79038 1.159354,-1.62945 1.166854,-2.68769 0.0051,-0.71826 -0.109042,-1.16342 -0.472839,-1.84278 l -0.250631,-0.46768 0.655257,-0.30644 c 1.24723,-0.58276 2.990997,-1.13889 4.186825,-1.33583 l 0.653707,-0.10801 0.01757,-2.10685 c 0.0177,-2.10684 0.01764,-2.10652 -0.166398,-2.36574 -0.101221,-0.14257 -0.203567,-0.28098 -0.227377,-0.30748 -0.02381,-0.0265 -0.329243,-0.005 -0.679028,0.0476 -1.052255,0.1589 -2.660973,0.18808 -3.863847,0.0698 -3.848795,-0.3786 -6.783429,-1.71774 -9.147245,-4.17339 -0.854617,-0.88782 -1.392664,-1.64426 -1.856218,-2.61018 -0.728168,-1.51731 -0.918492,-2.41698 -0.918807,-4.34857 -2.06e-4,-1.26958 0.01138,-1.39703 0.20774,-2.33267 0.274087,-1.30602 0.57009,-2.17611 1.128096,-3.31556 0.781201,-1.59521 1.54617,-2.6803 2.716113,-3.85351 1.777221,-1.78219 3.761129,-2.91711 6.197555,-3.54449 1.894563,-0.48786 4.220783,-0.52557 6.124691,-0.0997 1.375101,0.30756 3.13871,1.04772 4.235917,1.77767 1.157789,0.77025 2.478677,1.96713 3.265434,2.959 1.800747,2.27019 2.836652,5.16803 2.834452,7.92974 -4.4e-4,0.54516 -0.02145,1.16748 -0.04651,1.38287 l -0.04547,0.39119 0.29869,0.045 c 0.16441,0.0246 0.51737,0.15765 0.783931,0.29559 0.266561,0.13792 0.489144,0.24413 0.494544,0.23513 0.0054,-0.009 0.04649,-0.20288 0.09147,-0.4315 0.12142,-0.61721 0.16276,-2.69139 0.07028,-3.53777 -0.139665,-1.27827 -0.65157,-2.9984 -1.315165,-4.42091 -0.513085,-1.30958 -1.24392,-2.48579 -2.13217,-3.52589 0.372988,-0.59752 0.793048,-1.67734 0.910539,-2.62464 0.427811,-3.44996 -2.154955,-5.84801 -5.087545,-5.7888 z m -0.434082,10.87272 c -0.575424,0.008 -1.042246,0.18913 -1.223698,0.57465 -0.197385,0.41933 -0.0077,1.5958 0.42168,2.61431 0.429404,1.01849 0.946696,2.85455 1.149284,4.07985 0.202579,1.22528 0.544662,2.27336 0.760677,2.32906 0.722621,0.18654 2.845073,-1.75867 3.132108,-2.87063 0.411541,-1.5943 -0.219526,-4.28953 -1.276408,-5.45134 -0.743877,-0.81772 -2.004602,-1.28859 -2.963643,-1.2759 z m -10.012309,0.98806 c -3.528277,0.0934 -5.838482,4.99314 -3.546553,8.58345 0.885046,1.38637 2.226,1.85194 3.674711,1.27538 1.007556,-0.40098 1.093604,-0.60003 3.03444,-7.03782 0.434036,-1.43969 -0.141266,-2.20056 -2.032434,-2.68872 -0.387314,-0.1 -0.765169,-0.14195 -1.130164,-0.13229 z m 10.825179,0.55759 c 0.179373,4.3e-4 0.371019,0.0392 0.568958,0.12144 0.710073,0.29493 0.891567,0.69985 0.680578,1.51722 -0.210988,0.81739 -0.566042,1.08398 -1.330151,0.99838 -0.625201,-0.0701 -1.077404,-0.42513 -1.130164,-0.88676 -0.118081,-1.03335 0.433499,-1.75214 1.210779,-1.75028 z m -10.722859,1.43608 c 0.683536,0.0418 1.355089,0.79025 1.124479,1.68362 -0.205655,0.7967 -0.567761,1.08363 -1.269173,1.00563 -1.071281,-0.1193 -1.427672,-1.24983 -0.711068,-2.25568 0.232086,-0.32576 0.545063,-0.45257 0.855762,-0.43357 z m 6.597013,6.15415 c -1.844889,0.0753 -2.670598,1.3723 -0.792717,2.27945 1.435967,0.6937 1.496565,1.23154 0.180868,1.60248 -0.812619,0.22916 -0.808192,0.27811 0.04754,0.5116 0.519945,0.14217 1.272944,0.0219 1.673283,-0.26717 0.571645,-0.41301 0.610524,-0.55648 0.179834,-0.66766 -0.30156,-0.0779 -0.389779,-0.36807 -0.195337,-0.64492 1.504051,-2.1424 1.528878,-2.34052 0.326079,-2.651 -0.513588,-0.13257 -0.993809,-0.18015 -1.419552,-0.16278 z m 9.582361,1.02474 c -0.252108,-0.031 -0.520249,0.007 -0.779281,0.1323 -0.96759,0.46888 -0.953742,1.88627 0.02325,2.36988 0.757695,0.37505 1.690913,-0.0599 1.910477,-0.89039 0.213556,-0.80775 -0.398128,-1.51866 -1.154451,-1.61179 z m -3.712952,2.07636 c -0.387831,0.0373 -0.659783,0.23363 -0.795817,0.57361 -0.188926,0.47218 0.0226,0.98935 0.494027,1.20716 0.484127,0.22368 1.003728,0.031 1.250053,-0.46353 0.340453,-0.68353 -0.169665,-1.39204 -0.948263,-1.31724 z m 2.686658,1.75855 -0.38964,0.0351 c -0.478887,0.0434 -0.935512,0.26822 -1.129131,0.55552 -0.118421,0.17571 -0.144177,0.30076 -0.144177,0.70797 0,0.46938 -0.0089,0.50074 -0.1757,0.60927 -2.020146,1.31412 -3.061941,3.8217 -2.267045,5.45548 0.223834,0.46006 0.737506,0.97161 1.190625,1.18597 0.197147,0.0933 0.782227,0.28084 1.300696,0.41703 1.122255,0.29479 1.41068,0.40227 1.851567,0.6904 0.648461,0.4238 0.806656,0.6756 1.686202,2.67787 1.377789,3.13652 1.241496,2.88432 1.617472,2.99362 0.35675,0.10371 0.851588,0.20998 1.159102,0.24908 1.105271,0.1407 2.421644,-0.15941 3.328996,-0.75965 1.061045,-0.70192 1.84516,-1.89565 2.073775,-3.15639 0.102335,-0.56435 0.08602,-1.60591 -0.03514,-2.24534 -0.504509,-2.66268 -3.279894,-6.1002 -6.006868,-7.44038 -1.285483,-0.63175 -2.583164,-0.92696 -3.597197,-0.81752 l -0.463537,0.0501 v -0.6041 z m -3.566191,11.02052 c -0.140787,-0.0152 -0.285921,0.0257 -0.442867,0.12144 -0.439559,0.26802 -0.404656,0.98449 0.05788,1.18546 0.265457,0.11509 0.326845,0.11637 0.579809,0.009 0.312651,-0.13233 0.458887,-0.33234 0.458887,-0.62787 0,-0.21474 -0.03929,-0.29255 -0.237711,-0.47439 -0.139207,-0.12758 -0.275209,-0.19879 -0.415996,-0.21394 z m -0.0093,2.48667 c -0.350374,-0.0457 -0.709,0.18544 -0.709,0.6258 0,0.30004 0.228547,0.63128 0.465604,0.67438 0.549278,0.1 1.022836,-0.44535 0.785482,-0.90434 -0.124781,-0.2413 -0.33186,-0.3684 -0.542086,-0.39584 z m 15.514299,0.66456 c 0.158482,-0.0189 0.459432,0.21624 1.006657,0.72605 0.641738,0.59795 0.990813,1.26385 0.775146,1.4795 -0.215679,0.21569 -0.60733,0.044 -0.870231,-0.38137 -0.402864,-0.65184 -0.534004,-0.62851 -0.832507,0.14934 -0.488546,1.27305 -1.311031,1.16006 -1.311031,-0.18035 0,-0.60703 0.241097,-0.95467 0.535884,-0.77256 0.294787,0.18217 0.535885,-0.054 0.535885,-0.52504 0,-0.31237 0.03693,-0.4809 0.160197,-0.49557 z m -14.355196,1.79265 c -0.0843,0.002 -0.169129,0.0161 -0.253215,0.0429 -0.513711,0.16387 -0.835903,0.67333 -0.727087,1.1498 0.0956,0.41863 0.269406,0.63181 0.614949,0.75293 0.61415,0.21527 1.299327,-0.1813 1.406116,-0.81339 0.101084,-0.5983 -0.450685,-1.14788 -1.040763,-1.13223 z m -29.789396,0.35502 c 0.132611,0.0133 0.172599,0.16634 0.172599,0.4501 0,0.428 0.259553,0.6424 0.576709,0.47698 0.317155,-0.1655 0.576709,0.1504 0.576709,0.70176 0,1.20037 -0.199582,1.24255 -1.176156,0.24908 -0.579605,-0.58965 -0.838877,-0.61927 -1.192692,-0.13591 -0.248632,0.33974 -0.641822,0.45739 -0.873848,0.26149 -0.232026,-0.19591 0.143022,-0.80095 0.833541,-1.34411 0.588773,-0.46309 0.912638,-0.67653 1.083138,-0.65939 z m 44.607096,2.48202 c 0.02418,0.002 0.04788,0.006 0.07183,0.014 0.762745,0.25032 1.129559,2.67808 0.676962,4.48138 -0.405365,1.61529 -1.708716,1.65996 -2.012797,0.0692 -0.321039,-1.67938 0.514563,-4.61164 1.264005,-4.56458 z m -39.335583,0.0677 c 0.562864,0.39977 1.408645,0.90847 1.540474,0.90847 0.04144,0 0.07028,0.1267 0.07028,0.30799 0,0.71262 0.314282,2.59447 0.612882,3.66954 0.02278,0.082 0.03239,0.12398 0.05013,0.18914 -0.58812,-0.94796 -1.279075,-2.4395 -1.614372,-3.51348 -0.171551,-0.54947 -0.409121,-1.09759 -0.659391,-1.56166 z m 20.921203,0.29352 c -0.09349,-0.001 -0.188274,0.0114 -0.283187,0.0393 -0.999092,0.29373 -1.081806,1.55059 -0.130741,1.98954 0.300291,0.1386 0.364974,0.14333 0.700732,0.0501 0.325701,-0.0904 0.640072,-0.4073 0.742074,-0.74776 0.196535,-0.65597 -0.374471,-1.32396 -1.028878,-1.33118 z m 4.593518,0.72295 c -0.166521,-0.005 -0.343217,0.0311 -0.518314,0.11421 -0.543037,0.25778 -0.666961,1.18441 -0.20929,1.56424 0.05474,0.0454 0.207805,0.1219 0.340031,0.1695 0.597757,0.21514 1.295528,-0.26695 1.295528,-0.89504 0,-0.55829 -0.40839,-0.93825 -0.907955,-0.95291 z m -31.271993,0.6258 c 0.731961,0.0265 1.218941,1.23244 1.226282,3.18585 0.009,2.11984 -1.206232,2.9305 -1.947685,1.29915 -0.577884,-1.27145 -0.395352,-4.01733 0.290939,-4.37544 0.150859,-0.0787 0.294916,-0.11447 0.430464,-0.10956 z" /></g></svg>
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,19 +1,7 @@
 API Reference
 =============
 
-Methods
--------
-
 .. automodule:: pandalchemy.methods
    :members:
    :undoc-members:
    :show-inheritance:
-
-Individual Functions
---------------------
-
-.. autofunction:: pandalchemy.methods.select
-.. autofunction:: pandalchemy.methods.where_
-.. autofunction:: pandalchemy.methods.group_by
-
-# Add more functions as needed
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,5 +21,6 @@
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
+html_theme = 'alabaster'
+html_static_path = ['_static']
+html_logo = '_images/logo.png'
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,18 +1,12 @@
 Welcome to Pandalchemy's documentation!
 =======================================
 
+Pandalchemy is a simple Python package that provides methods to query pandas DataFrames using a SQL-like synthax.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    installation
-   usage
    api
-   examples/basic-usage
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   _examples/basic-usage
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,3 @@
+Installation
+============
+
