Generate documentation for 0.2.1 with Sphinx>=3.2

McSinyx · Aug 10, 2020 · 3339433 · 3339433
1 parent e05ced9
commit 3339433
Show file tree

Hide file tree

Showing 44 changed files with 210 additions and 188 deletions.
diff --git a/doctrees/contributing.doctree b/doctrees/contributing.doctree
diff --git a/doctrees/copying.doctree b/doctrees/copying.doctree
diff --git a/doctrees/design.doctree b/doctrees/design.doctree
diff --git a/doctrees/environment.pickle b/doctrees/environment.pickle
diff --git a/doctrees/index.doctree b/doctrees/index.doctree
diff --git a/doctrees/installation.doctree b/doctrees/installation.doctree
diff --git a/doctrees/reference/buffer.doctree b/doctrees/reference/buffer.doctree
diff --git a/doctrees/reference/context.doctree b/doctrees/reference/context.doctree
diff --git a/doctrees/reference/decoder.doctree b/doctrees/reference/decoder.doctree
diff --git a/doctrees/reference/device.doctree b/doctrees/reference/device.doctree
diff --git a/doctrees/reference/effect.doctree b/doctrees/reference/effect.doctree
diff --git a/doctrees/reference/file-io.doctree b/doctrees/reference/file-io.doctree
diff --git a/doctrees/reference/index.doctree b/doctrees/reference/index.doctree
diff --git a/doctrees/reference/source.doctree b/doctrees/reference/source.doctree
diff --git a/doctrees/tutorial/context.doctree b/doctrees/tutorial/context.doctree
diff --git a/doctrees/tutorial/index.doctree b/doctrees/tutorial/index.doctree
diff --git a/doctrees/tutorial/play-audio.doctree b/doctrees/tutorial/play-audio.doctree
diff --git a/doctrees/tutorial/source.doctree b/doctrees/tutorial/source.doctree
diff --git a/html/.buildinfo b/html/.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: fc15dbac7c31a57892fa25f1fdd83f1e
+config: 15f696dd8f7d3d70ce592a5e4a09ce3d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/html/_static/basic.css b/html/_static/basic.css
@@ -693,7 +693,7 @@ pre {
     overflow-y: hidden;  /* fixes display issues on Chrome browsers */
 }
 
-pre, div[class|="highlight"] {
+pre, div[class*="highlight-"] {
     clear: both;
 }
 
@@ -704,7 +704,7 @@ span.pre {
     hyphens: none;
 }
 
-div[class^="highlight-"] {
+div[class*="highlight-"] {
     margin: 1em 0;
 }
 

diff --git a/html/_static/documentation_options.js b/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.2.0',
+    VERSION: '0.2.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/html/_static/searchtools.js b/html/_static/searchtools.js
@@ -166,8 +166,7 @@ var Search = {
           objectterms.push(tmp[i].toLowerCase());
       }
 
-      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
-          tmp[i] === "") {
+      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
         // skip this "word"
         continue;
       }

diff --git a/html/contributing.html b/html/contributing.html
@@ -4,8 +4,8 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Getting Involved &#8212; palace 0.2.0 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Getting Involved &#8212; palace 0.2.1 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -317,7 +317,7 @@ <h3>reStructuredText<a class="headerlink" href="#restructuredtext" title="Permal
       &copy;2019, 2020  Nguyễn Gia Phong et al.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0+</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/html/copying.html b/html/copying.html
@@ -4,8 +4,8 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Copying &#8212; palace 0.2.0 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Copying &#8212; palace 0.2.1 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -209,7 +209,7 @@ <h2>Credits<a class="headerlink" href="#credits" title="Permalink to this headli
       &copy;2019, 2020  Nguyễn Gia Phong et al.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0+</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/html/design.html b/html/design.html
@@ -4,8 +4,8 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Design Principles &#8212; palace 0.2.0 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Design Principles &#8212; palace 0.2.1 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -284,7 +284,7 @@ <h2>The Double Reference<a class="headerlink" href="#the-double-reference" title
       &copy;2019, 2020  Nguyễn Gia Phong et al.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0+</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/html/genindex.html b/html/genindex.html
@@ -4,8 +4,8 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Index &#8212; palace 0.2.0 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Index &#8212; palace 0.2.1 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -710,7 +710,7 @@ <h2 id="W">W</h2>
       &copy;2019, 2020  Nguyễn Gia Phong et al.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0+</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
     </div>

diff --git a/html/index.html b/html/index.html
@@ -4,8 +4,8 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Overview &#8212; palace 0.2.0 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview &#8212; palace 0.2.1 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -189,7 +189,7 @@ <h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Pe
       &copy;2019, 2020  Nguyễn Gia Phong et al.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0+</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/html/installation.html b/html/installation.html
@@ -4,8 +4,8 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Installation &#8212; palace 0.2.0 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Installation &#8212; palace 0.2.1 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -162,7 +162,7 @@ <h2>From source<a class="headerlink" href="#from-source" title="Permalink to thi
       &copy;2019, 2020  Nguyễn Gia Phong et al.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0+</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/html/reference/buffer.html b/html/reference/buffer.html
@@ -4,8 +4,8 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Resource Caching &#8212; palace 0.2.0 documentation</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Resource Caching &#8212; palace 0.2.1 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
@@ -125,9 +125,9 @@ <h2>Audio Buffers<a class="headerlink" href="#audio-buffers" title="Permalink to
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>name</strong> (<em>str</em>) – Audio file or resource name.  Multiple calls with the same name
+<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Audio file or resource name.  Multiple calls with the same name
 will return the same buffer.</p></li>
-<li><p><strong>context</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="context.html#palace.Context" title="palace.Context"><em>Context</em></a><em>]</em><em>, </em><em>optional</em>) – The context from which the buffer is to be created and cached.
+<li><p><strong>context</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Optional[Context]</span></code>, <em>optional</em>) – The context from which the buffer is to be created and cached.
 By default <cite>current_context()</cite> is used.</p></li>
 </ul>
 </dd>
@@ -138,7 +138,7 @@ <h2>Audio Buffers<a class="headerlink" href="#audio-buffers" title="Permalink to
 <dd><p>Audio file or resource name.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Type</dt>
-<dd class="field-odd"><p>str</p>
+<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
 </dd>
 </dl>
 </dd></dl>
@@ -174,10 +174,10 @@ <h2>Audio Buffers<a class="headerlink" href="#audio-buffers" title="Permalink to
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>decoder</strong> (<a class="reference internal" href="decoder.html#palace.Decoder" title="palace.Decoder"><em>Decoder</em></a>) – The decoder from which the buffer is to be cached.</p></li>
-<li><p><strong>name</strong> (<em>str</em>) – The name to give to the buffer.  It may alias an audio file,
+<li><p><strong>decoder</strong> (<a class="reference internal" href="decoder.html#palace.Decoder" title="palace.Decoder"><code class="xref py py-class docutils literal notranslate"><span class="pre">Decoder</span></code></a>) – The decoder from which the buffer is to be cached.</p></li>
+<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name to give to the buffer.  It may alias an audio file,
 but it must not currently exist in the buffer cache.</p></li>
-<li><p><strong>context</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="context.html#palace.Context" title="palace.Context"><em>Context</em></a><em>]</em><em>, </em><em>optional</em>) – The context from which the buffer is to be created.
+<li><p><strong>context</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Optional[Context]</span></code>, <em>optional</em>) – The context from which the buffer is to be created.
 By default <cite>current_context()</cite> is used.</p></li>
 </ul>
 </dd>
@@ -204,15 +204,16 @@ <h2>Audio Buffers<a class="headerlink" href="#audio-buffers" title="Permalink to
 <dt id="palace.Buffer.loop_points">
 <code class="sig-name descname">loop_points</code><a class="headerlink" href="#palace.Buffer.loop_points" title="Permalink to this definition">¶</a></dt>
 <dd><p>Loop points for looping sources.</p>
-<p>If the <cite>AL_SOFT_loop_points</cite> extension is not supported by the
+<p>If <cite>AL_SOFT_loop_points</cite> extension is not supported by the
 current context, <cite>start = 0</cite> and <cite>end = length</cite> respectively.
 Otherwise, <cite>start &lt; end &lt;= length</cite>.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>start</strong> (<em>int</em>) – Starting point, in sample frames (inclusive).</p></li>
-<li><p><strong>end</strong> (<em>int</em>) – Ending point, in sample frames (exclusive).</p></li>
+<dt class="field-odd">Returns</dt>
+<dd class="field-odd"><p><ul class="simple">
+<li><p><strong>start</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Starting point, in sample frames (inclusive).</p></li>
+<li><p><strong>end</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – Ending point, in sample frames (exclusive).</p></li>
 </ul>
+</p>
 </dd>
 </dl>
 <p class="rubric">Notes</p>
@@ -335,7 +336,7 @@ <h2>Loading &amp; Freeing in Batch<a class="headerlink" href="#loading-freeing-i
       &copy;2019, 2020  Nguyễn Gia Phong et al.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0+</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |