Skip to content

Commit

Permalink
Re-generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Dec 27, 2023
1 parent e39373c commit 6dace36
Showing 1 changed file with 56 additions and 16 deletions.
72 changes: 56 additions & 16 deletions docs/fastexcel.html
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.2.0"/>
<meta name="generator" content="pdoc 14.3.0"/>
<title>fastexcel 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 @@ -430,13 +430,21 @@ <h1 class="modulename">

</div>
<div id="ExcelReader.sheet_names" class="classattr">
<div class="attr variable">
<input id="ExcelReader.sheet_names-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">sheet_names</span><span class="annotation">: list[str]</span>


<label class="view-source-button" for="ExcelReader.sheet_names-view-source"><span>View Source</span></label>

</div>
<a class="headerlink" href="#ExcelReader.sheet_names"></a>

<div class="pdoc-code codehilite"><pre><span></span><span id="ExcelReader.sheet_names-73"><a href="#ExcelReader.sheet_names-73"><span class="linenos">73</span></a> <span class="nd">@property</span>
</span><span id="ExcelReader.sheet_names-74"><a href="#ExcelReader.sheet_names-74"><span class="linenos">74</span></a> <span class="k">def</span> <span class="nf">sheet_names</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
</span><span id="ExcelReader.sheet_names-75"><a href="#ExcelReader.sheet_names-75"><span class="linenos">75</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;The list of sheet names&quot;&quot;&quot;</span>
</span><span id="ExcelReader.sheet_names-76"><a href="#ExcelReader.sheet_names-76"><span class="linenos">76</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_reader</span><span class="o">.</span><span class="n">sheet_names</span>
</span></pre></div>


<div class="docstring"><p>The list of sheet names</p>
</div>

Expand Down Expand Up @@ -706,52 +714,84 @@ <h6 id="parameters">Parameters</h6>

</div>
<div id="ExcelSheet.name" class="classattr">
<div class="attr variable">
<input id="ExcelSheet.name-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">name</span><span class="annotation">: str</span>


<label class="view-source-button" for="ExcelSheet.name-view-source"><span>View Source</span></label>

</div>
<a class="headerlink" href="#ExcelSheet.name"></a>

<div class="pdoc-code codehilite"><pre><span></span><span id="ExcelSheet.name-20"><a href="#ExcelSheet.name-20"><span class="linenos">20</span></a> <span class="nd">@property</span>
</span><span id="ExcelSheet.name-21"><a href="#ExcelSheet.name-21"><span class="linenos">21</span></a> <span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
</span><span id="ExcelSheet.name-22"><a href="#ExcelSheet.name-22"><span class="linenos">22</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;The name of the sheet&quot;&quot;&quot;</span>
</span><span id="ExcelSheet.name-23"><a href="#ExcelSheet.name-23"><span class="linenos">23</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sheet</span><span class="o">.</span><span class="n">name</span>
</span></pre></div>


<div class="docstring"><p>The name of the sheet</p>
</div>


</div>
<div id="ExcelSheet.width" class="classattr">
<div class="attr variable">
<input id="ExcelSheet.width-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">width</span><span class="annotation">: int</span>


<label class="view-source-button" for="ExcelSheet.width-view-source"><span>View Source</span></label>

</div>
<a class="headerlink" href="#ExcelSheet.width"></a>

<div class="pdoc-code codehilite"><pre><span></span><span id="ExcelSheet.width-25"><a href="#ExcelSheet.width-25"><span class="linenos">25</span></a> <span class="nd">@property</span>
</span><span id="ExcelSheet.width-26"><a href="#ExcelSheet.width-26"><span class="linenos">26</span></a> <span class="k">def</span> <span class="nf">width</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
</span><span id="ExcelSheet.width-27"><a href="#ExcelSheet.width-27"><span class="linenos">27</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;The sheet&#39;s width&quot;&quot;&quot;</span>
</span><span id="ExcelSheet.width-28"><a href="#ExcelSheet.width-28"><span class="linenos">28</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sheet</span><span class="o">.</span><span class="n">width</span>
</span></pre></div>


<div class="docstring"><p>The sheet's width</p>
</div>


</div>
<div id="ExcelSheet.height" class="classattr">
<div class="attr variable">
<input id="ExcelSheet.height-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">height</span><span class="annotation">: int</span>


<label class="view-source-button" for="ExcelSheet.height-view-source"><span>View Source</span></label>

</div>
<a class="headerlink" href="#ExcelSheet.height"></a>

<div class="pdoc-code codehilite"><pre><span></span><span id="ExcelSheet.height-30"><a href="#ExcelSheet.height-30"><span class="linenos">30</span></a> <span class="nd">@property</span>
</span><span id="ExcelSheet.height-31"><a href="#ExcelSheet.height-31"><span class="linenos">31</span></a> <span class="k">def</span> <span class="nf">height</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
</span><span id="ExcelSheet.height-32"><a href="#ExcelSheet.height-32"><span class="linenos">32</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;The sheet&#39;s height, with `skip_rows` and `nrows` applied&quot;&quot;&quot;</span>
</span><span id="ExcelSheet.height-33"><a href="#ExcelSheet.height-33"><span class="linenos">33</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sheet</span><span class="o">.</span><span class="n">height</span>
</span></pre></div>


<div class="docstring"><p>The sheet's height, with <code>skip_rows</code> and <code>nrows</code> applied</p>
</div>


</div>
<div id="ExcelSheet.total_height" class="classattr">
<div class="attr variable">
<input id="ExcelSheet.total_height-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr variable">
<span class="name">total_height</span><span class="annotation">: int</span>


<label class="view-source-button" for="ExcelSheet.total_height-view-source"><span>View Source</span></label>

</div>
<a class="headerlink" href="#ExcelSheet.total_height"></a>

<div class="pdoc-code codehilite"><pre><span></span><span id="ExcelSheet.total_height-35"><a href="#ExcelSheet.total_height-35"><span class="linenos">35</span></a> <span class="nd">@property</span>
</span><span id="ExcelSheet.total_height-36"><a href="#ExcelSheet.total_height-36"><span class="linenos">36</span></a> <span class="k">def</span> <span class="nf">total_height</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
</span><span id="ExcelSheet.total_height-37"><a href="#ExcelSheet.total_height-37"><span class="linenos">37</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;The sheet&#39;s total height&quot;&quot;&quot;</span>
</span><span id="ExcelSheet.total_height-38"><a href="#ExcelSheet.total_height-38"><span class="linenos">38</span></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sheet</span><span class="o">.</span><span class="n">total_height</span>
</span></pre></div>


<div class="docstring"><p>The sheet's total height</p>
</div>

Expand Down

0 comments on commit 6dace36

Please sign in to comment.