Update documentation

ApeWorX · Oct 3, 2024 · 5eae2a3 · 5eae2a3
1 parent b112be5
commit 5eae2a3
Show file tree

Hide file tree

Showing 21 changed files with 31 additions and 24 deletions.
diff --git a/index.html b/index.html
@@ -2,4 +2,4 @@
 <!DOCTYPE html>
 <meta charset="utf-8">
 <title>Redirecting...</title>
-<meta http-equiv="refresh" content="0; URL=./stable/">
+<meta http-equiv="refresh" content="0; URL=./latest/">
diff --git a/latest/.buildinfo b/latest/.buildinfo
@@ -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: 6163d73c04d29282fb132c0f609dc71f
+config: 5abff1be51ee6f37bd269854b206d7f3
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/methoddocs/build.doctree b/latest/.doctrees/methoddocs/build.doctree
diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree
diff --git a/latest/.doctrees/methoddocs/testing.doctree b/latest/.doctrees/methoddocs/testing.doctree
diff --git a/latest/commands/build.html b/latest/commands/build.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="../">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>build - sphinx-ape documentation</title><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="init" href="init.html" /><link rel="prev" title="Quick Start" href="../userguides/quickstart.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>build - sphinx-ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="init" href="init.html" /><link rel="prev" title="Quick Start" href="../userguides/quickstart.html" />
       <link rel="canonical" href="sphinx-ape/commands/build.html" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");

diff --git a/latest/commands/init.html b/latest/commands/init.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="../">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>init - sphinx-ape documentation</title><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="publish" href="publish.html" /><link rel="prev" title="build" href="build.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>init - sphinx-ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="publish" href="publish.html" /><link rel="prev" title="build" href="build.html" />
       <link rel="canonical" href="sphinx-ape/commands/init.html" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");

diff --git a/latest/commands/publish.html b/latest/commands/publish.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="../">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>publish - sphinx-ape documentation</title><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="serve" href="serve.html" /><link rel="prev" title="init" href="init.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>publish - sphinx-ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="serve" href="serve.html" /><link rel="prev" title="init" href="init.html" />
       <link rel="canonical" href="sphinx-ape/commands/publish.html" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");

diff --git a/latest/commands/serve.html b/latest/commands/serve.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="../">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>serve - sphinx-ape documentation</title><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="test" href="test.html" /><link rel="prev" title="publish" href="publish.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>serve - sphinx-ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="test" href="test.html" /><link rel="prev" title="publish" href="publish.html" />
       <link rel="canonical" href="sphinx-ape/commands/serve.html" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");

diff --git a/latest/commands/test.html b/latest/commands/test.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="../">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>test - sphinx-ape documentation</title><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Builder APIs" href="../methoddocs/build.html" /><link rel="prev" title="serve" href="serve.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>test - sphinx-ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Builder APIs" href="../methoddocs/build.html" /><link rel="prev" title="serve" href="serve.html" />
       <link rel="canonical" href="sphinx-ape/commands/test.html" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");

diff --git a/latest/genindex.html b/latest/genindex.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="./">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Index - sphinx-ape documentation</title><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Index - sphinx-ape documentation</title><link rel="shortcut icon" href="_static/favicon.ico"/><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
       <link rel="canonical" href="sphinx-ape/genindex.html" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");
@@ -183,6 +183,8 @@ <h2 id="B">B</h2>
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="methoddocs/testing.html#sphinx_ape.testing.DocumentationTester.doctest_folder">doctest_folder (sphinx_ape.testing.DocumentationTester property)</a>
+</li>
       <li><a href="methoddocs/testing.html#sphinx_ape.testing.DocumentationTester.doctest_output_file">doctest_output_file (sphinx_ape.testing.DocumentationTester property)</a>
 </li>
   </ul></td>

diff --git a/latest/index.html b/latest/index.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="./">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>sphinx-ape documentation</title><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Quick Start" href="userguides/quickstart.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>sphinx-ape documentation</title><link rel="shortcut icon" href="_static/favicon.ico"/><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Quick Start" href="userguides/quickstart.html" />
       <link rel="canonical" href="sphinx-ape/" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");

diff --git a/latest/methoddocs/build.html b/latest/methoddocs/build.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="../">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Builder APIs - sphinx-ape documentation</title><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Exceptions" href="exceptions.html" /><link rel="prev" title="test" href="../commands/test.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Builder APIs - sphinx-ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Exceptions" href="exceptions.html" /><link rel="prev" title="test" href="../commands/test.html" />
       <link rel="canonical" href="sphinx-ape/methoddocs/build.html" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");
@@ -161,14 +161,12 @@
 <span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sphinx_ape.build.DocumentationBuilder.build" title="Link to this definition"></a></dt>
 <dd><p>Build the documentation.</p>
 <p class="rubric">Example</p>
-<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">sphinx_ape.build</span> <span class="kn">import</span> <span class="n">BuildMode</span><span class="p">,</span> <span class="n">DocumentationBuilder</span>
-</span><span data-line="2"><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
-</span><span data-line="3"><span class="gp">&gt;&gt;&gt; </span><span class="n">builder</span> <span class="o">=</span> <span class="n">DocumentationBuilder</span><span class="p">(</span>
-</span><span data-line="4"><span class="gp">... </span>  <span class="n">mode</span><span class="o">=</span><span class="n">BuildMode</span><span class="o">.</span><span class="n">LATEST</span><span class="p">,</span>
-</span><span data-line="5"><span class="gp">... </span>  <span class="n">base_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="s2">&quot;.&quot;</span><span class="p">),</span>
-</span><span data-line="6"><span class="gp">... </span>  <span class="n">name</span><span class="o">=</span><span class="s2">&quot;sphinx-ape&quot;</span>
-</span><span data-line="7"><span class="gp">... </span><span class="p">)</span>
-</span><span data-line="8"><span class="gp">&gt;&gt;&gt; </span><span class="n">builder</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="gp">&gt;&gt;&gt; </span><span class="n">builder</span> <span class="o">=</span> <span class="n">DocumentationBuilder</span><span class="p">(</span>
+</span><span data-line="2"><span class="gp">... </span>  <span class="n">mode</span><span class="o">=</span><span class="n">BuildMode</span><span class="o">.</span><span class="n">LATEST</span><span class="p">,</span>
+</span><span data-line="3"><span class="gp">... </span>  <span class="n">base_path</span><span class="o">=</span><span class="n">Path</span><span class="o">.</span><span class="n">cwd</span><span class="p">(),</span>
+</span><span data-line="4"><span class="gp">... </span>  <span class="n">name</span><span class="o">=</span><span class="s2">&quot;sphinx-ape&quot;</span>
+</span><span data-line="5"><span class="gp">... </span><span class="p">)</span>
+</span><span data-line="6"><span class="gp">&gt;&gt;&gt; </span><span class="n">builder</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>
 </span></pre></div>
 </div>
 <dl class="field-list simple">

diff --git a/latest/methoddocs/exceptions.html b/latest/methoddocs/exceptions.html
@@ -2,7 +2,7 @@
 <html lang="en" data-accent-color="lime" data-content_root="../">
 <head>
   <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Exceptions - sphinx-ape documentation</title><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Tester APIs" href="testing.html" /><link rel="prev" title="Builder APIs" href="build.html" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Exceptions - sphinx-ape documentation</title><link rel="shortcut icon" href="../_static/favicon.ico"/><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Tester APIs" href="testing.html" /><link rel="prev" title="Builder APIs" href="build.html" />
       <link rel="canonical" href="sphinx-ape/methoddocs/exceptions.html" /><script>
     function setColorMode(t){let e=document.documentElement;e.setAttribute("data-color-mode",t);let a=window.matchMedia&&window.matchMedia("(prefers-color-scheme: dark)").matches,s=t;"auto"===t&&(s=a?"dark":"light"),"light"===s?(e.classList.remove("dark"),e.classList.add("light")):(e.classList.remove("light"),e.classList.add("dark"))}
     setColorMode(localStorage._theme||"auto");