Skip to content
This repository has been archived by the owner on Nov 21, 2020. It is now read-only.

Generate documentation with Sphinx>=3.2 #110

Merged
merged 1 commit into from Aug 10, 2020
Merged

Generate documentation with Sphinx>=3.2 #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file modified doctrees/contributing.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/copying.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/design.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/installation.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/reference/buffer.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/reference/context.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/reference/decoder.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/reference/device.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/reference/effect.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/reference/file-io.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/reference/index.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/reference/source.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/tutorial/context.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/tutorial/index.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/tutorial/play-audio.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified doctrees/tutorial/source.doctree
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion html/.buildinfo
View file
Open in desktop
@@ -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
4 changes: 2 additions & 2 deletions html/_static/basic.css
View file
Open in desktop
Expand Up @@ -693,7 +693,7 @@ pre {
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}

pre, div[class|="highlight"] {
pre, div[class*="highlight-"] {
clear: both;
}

Expand All @@ -704,7 +704,7 @@ span.pre {
hyphens: none;
}

div[class^="highlight-"] {
div[class*="highlight-"] {
margin: 1em 0;
}

Expand Down
2 changes: 1 addition & 1 deletion html/_static/documentation_options.js
View file
Open in desktop
@@ -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',
Expand Down
3 changes: 1 addition & 2 deletions html/_static/searchtools.js
View file
Open in desktop
Expand Up @@ -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;
}
Expand Down
6 changes: 3 additions & 3 deletions html/contributing.html
View file
Open in desktop
Expand Up @@ -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>
Expand Down Expand Up @@ -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>

|
Expand Down
6 changes: 3 additions & 3 deletions html/copying.html
View file
Open in desktop
Expand Up @@ -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>
Expand Down Expand Up @@ -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>

|
Expand Down
6 changes: 3 additions & 3 deletions html/design.html
View file
Open in desktop
Expand Up @@ -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>
Expand Down Expand Up @@ -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>

|
Expand Down
6 changes: 3 additions & 3 deletions html/genindex.html
View file
Open in desktop
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions html/index.html
View file
Open in desktop
Expand Up @@ -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>
Expand Down Expand Up @@ -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>

|
Expand Down
6 changes: 3 additions & 3 deletions html/installation.html
View file
Open in desktop
Expand Up @@ -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>
Expand Down Expand Up @@ -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>

|
Expand Down
29 changes: 15 additions & 14 deletions html/reference/buffer.html
View file
Open in desktop
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>

|
Expand Down