Skip to content

Commit

Permalink
:octocat: Update docs for #527
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed May 25, 2024
1 parent 415a51b commit ab33256
Show file tree
Hide file tree
Showing 20 changed files with 846 additions and 825 deletions.
2 changes: 1 addition & 1 deletion api/search.js
View file

Large diffs are not rendered by default.

22 changes: 12 additions & 10 deletions api/serde.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="pdoc 14.4.0"/>
<meta name="generator" content="pdoc 14.5.0"/>
<title>serde 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>
Expand Down Expand Up @@ -272,6 +272,7 @@ <h2 id="features">Features</h2>
<li>PyPI library
<ul>
<li><a href="https://github.com/numpy/numpy"><code>numpy</code></a> types</li>
<li><a href="https://github.com/sqlalchemy/sqlalchemy"><code>SQLAlchemy</code></a> Declarative Dataclass Mapping (experimental)</li>
</ul></li>
</ul></li>
<li><a href="https://github.com/yukinarit/pyserde/blob/main/docs/en/class-attributes.md">Class Attributes</a></li>
Expand Down Expand Up @@ -348,7 +349,8 @@ <h2 id="contributors">Contributors ✨</h2>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rtbs-dev"><img src="https://avatars.githubusercontent.com/u/12550525?v=4?s=60" width="60px;" alt="Rachael Sexton"/><br /><sub><b>Rachael Sexton</b></sub></a><br /><a href="https://github.com/yukinarit/pyserde/commits?author=rtbs-dev" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/JWSong"><img src="https://avatars.githubusercontent.com/u/4515331?v=4?s=60" width="60px;" alt="JWSong"/><br /><sub><b>JWSong</b></sub></a><br /><a href="https://github.com/yukinarit/pyserde/commits?author=JWSong" title="Code">💻</a></td> </tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/JWSong"><img src="https://avatars.githubusercontent.com/u/4515331?v=4?s=60" width="60px;" alt="JWSong"/><br /><sub><b>JWSong</b></sub></a><br /><a href="https://github.com/yukinarit/pyserde/commits?author=JWSong" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.mechanicus.it/"><img src="https://avatars.githubusercontent.com/u/13484760?v=4?s=60" width="60px;" alt="Emanuele Barsanti"/><br /><sub><b>Emanuele Barsanti</b></sub></a><br /><a href="https://github.com/yukinarit/pyserde/commits?author=barsa-net" title="Code">💻</a></td>
</tr>
</tbody>
<tfoot>
Expand Down Expand Up @@ -1432,10 +1434,10 @@ <h2 id="modules">Modules</h2>

</div>
<a class="headerlink" href="#SerdeError"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="SerdeError-74"><a href="#SerdeError-74"><span class="linenos">74</span></a><span class="k">class</span> <span class="nc">SerdeError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
</span><span id="SerdeError-75"><a href="#SerdeError-75"><span class="linenos">75</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="SerdeError-76"><a href="#SerdeError-76"><span class="linenos">76</span></a><span class="sd"> Serde error class.</span>
</span><span id="SerdeError-77"><a href="#SerdeError-77"><span class="linenos">77</span></a><span class="sd"> &quot;&quot;&quot;</span>
<div class="pdoc-code codehilite"><pre><span></span><span id="SerdeError-76"><a href="#SerdeError-76"><span class="linenos">76</span></a><span class="k">class</span> <span class="nc">SerdeError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
</span><span id="SerdeError-77"><a href="#SerdeError-77"><span class="linenos">77</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="SerdeError-78"><a href="#SerdeError-78"><span class="linenos">78</span></a><span class="sd"> Serde error class.</span>
</span><span id="SerdeError-79"><a href="#SerdeError-79"><span class="linenos">79</span></a><span class="sd"> &quot;&quot;&quot;</span>
</span></pre></div>


Expand Down Expand Up @@ -1470,10 +1472,10 @@ <h5>Inherited Members</h5>

</div>
<a class="headerlink" href="#SerdeSkip"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="SerdeSkip-89"><a href="#SerdeSkip-89"><span class="linenos">89</span></a><span class="k">class</span> <span class="nc">SerdeSkip</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
</span><span id="SerdeSkip-90"><a href="#SerdeSkip-90"><span class="linenos">90</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="SerdeSkip-91"><a href="#SerdeSkip-91"><span class="linenos">91</span></a><span class="sd"> Skip a field in custom (de)serializer.</span>
</span><span id="SerdeSkip-92"><a href="#SerdeSkip-92"><span class="linenos">92</span></a><span class="sd"> &quot;&quot;&quot;</span>
<div class="pdoc-code codehilite"><pre><span></span><span id="SerdeSkip-91"><a href="#SerdeSkip-91"><span class="linenos">91</span></a><span class="k">class</span> <span class="nc">SerdeSkip</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
</span><span id="SerdeSkip-92"><a href="#SerdeSkip-92"><span class="linenos">92</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="SerdeSkip-93"><a href="#SerdeSkip-93"><span class="linenos">93</span></a><span class="sd"> Skip a field in custom (de)serializer.</span>
</span><span id="SerdeSkip-94"><a href="#SerdeSkip-94"><span class="linenos">94</span></a><span class="sd"> &quot;&quot;&quot;</span>
</span></pre></div>


Expand Down
Loading

0 comments on commit ab33256

Please sign in to comment.