Skip to content

Commit

Permalink
🐛 Add autodoc2 to fix type references in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew McIntosh committed Aug 7, 2024
1 parent 441f9b2 commit 20f9989
Show file tree
Hide file tree
Showing 15 changed files with 519 additions and 750 deletions.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: 99bb4e742d66bb352cbc54f971ab8b56
config: 367ac96c1690e27cf61dd3c0feee04b7
tags: 645f666f9bcd5a90fca523b33c5a78b7
7 changes: 4 additions & 3 deletions docs/html/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ const Search = {

htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
for (const removalQuery of [".headerlinks", "script", "style"]) {
for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
Expand Down Expand Up @@ -328,13 +328,14 @@ const Search = {
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
let score = Math.round(100 * queryLower.length / title.length)
const score = Math.round(Scorer.title * queryLower.length / title.length);
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score,
score + boost,
filenames[file],
]);
}
Expand Down
2 changes: 1 addition & 1 deletion docs/html/examples/create_invoice_extended.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ <h1>Create Invoice - Extended<a class="headerlink" href="#create-invoice-extende
<span class="linenos"> 73</span> <span class="s2">&quot;theme_primary_color&quot;</span><span class="p">:</span> <span class="s2">&quot;#1fab13&quot;</span><span class="p">,</span>
<span class="linenos"> 74</span> <span class="s2">&quot;theme_layout&quot;</span><span class="p">:</span> <span class="s2">&quot;simple&quot;</span><span class="p">,</span>
<span class="linenos"> 75</span> <span class="s2">&quot;theme_font_name&quot;</span><span class="p">:</span> <span class="s2">&quot;modern&quot;</span><span class="p">,</span>
<span class="linenos"> 76</span> <span class="s2">&quot;image_logo_src&quot;</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;/uploads/images/</span><span class="si">{</span><span class="n">logo</span><span class="o">.</span><span class="n">jwt</span><span class="si">}</span><span class="s2">&quot;</span> <span class="c1"># The logo uplad response contains a jwt token</span>
<span class="linenos"> 76</span> <span class="s2">&quot;image_logo_src&quot;</span><span class="p">:</span> <span class="sa">f</span><span class="s2">&quot;/uploads/images/</span><span class="si">{</span><span class="n">logo</span><span class="o">.</span><span class="n">jwt</span><span class="si">}</span><span class="s2">&quot;</span> <span class="c1"># The logo upload response contains a jwt token</span>
<span class="linenos"> 77</span><span class="p">}</span>
<span class="linenos"> 78</span>
<span class="linenos"> 79</span><span class="n">invoice_data</span> <span class="o">=</span> <span class="p">{</span>
Expand Down
6 changes: 2 additions & 4 deletions docs/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -509,20 +509,18 @@ <h2 id="I">I</h2>
<li><a href="modules/client.html#freshbooks.client.Client.images">images (freshbooks.client.Client property)</a>
</li>
<li><a href="modules/builders.html#freshbooks.builders.filter.FilterBuilder.in_list">in_list() (freshbooks.builders.filter.FilterBuilder method)</a>
</li>
<li><a href="modules/builders.html#freshbooks.builders.includes.IncludesBuilder.include">include() (freshbooks.builders.includes.IncludesBuilder method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="modules/builders.html#freshbooks.builders.includes.IncludesBuilder.include">include() (freshbooks.builders.includes.IncludesBuilder method)</a>
</li>
<li><a href="modules/builders.html#freshbooks.builders.includes.IncludesBuilder">IncludesBuilder (class in freshbooks.builders.includes)</a>
</li>
<li><a href="modules/client.html#freshbooks.client.Client.invoice_payment_options">invoice_payment_options (freshbooks.client.Client property)</a>
</li>
<li><a href="modules/client.html#freshbooks.client.Client.invoice_profiles">invoice_profiles (freshbooks.client.Client property)</a>
</li>
<li><a href="modules/client.html#freshbooks.client.Client.invoices">invoices (freshbooks.client.Client property)</a>
</li>
<li><a href="modules/models.html#freshbooks.models.VisState.is_integer">is_integer() (freshbooks.models.VisState method)</a>
</li>
<li><a href="modules/client.html#freshbooks.client.Client.items">items (freshbooks.client.Client property)</a>
</li>
Expand Down
1 change: 0 additions & 1 deletion docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,6 @@ <h1>Welcome to freshbooks-sdk’s documentation!<a class="headerlink" href="#wel
<li class="toctree-l3"><a class="reference internal" href="modules/models.html#freshbooks.models.VisState.to_bytes"><code class="docutils literal notranslate"><span class="pre">VisState.to_bytes()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/models.html#freshbooks.models.VisState.from_bytes"><code class="docutils literal notranslate"><span class="pre">VisState.from_bytes()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/models.html#freshbooks.models.VisState.as_integer_ratio"><code class="docutils literal notranslate"><span class="pre">VisState.as_integer_ratio()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/models.html#freshbooks.models.VisState.is_integer"><code class="docutils literal notranslate"><span class="pre">VisState.is_integer()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/models.html#freshbooks.models.VisState.real"><code class="docutils literal notranslate"><span class="pre">VisState.real</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/models.html#freshbooks.models.VisState.imag"><code class="docutils literal notranslate"><span class="pre">VisState.imag</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/models.html#freshbooks.models.VisState.numerator"><code class="docutils literal notranslate"><span class="pre">VisState.numerator</span></code></a></li>
Expand Down
Loading

0 comments on commit 20f9989

Please sign in to comment.