McSinyx
/
palace
mirror of https://github.com/McSinyx/palace
1
1
Fork 0
Code Issues Releases Activity

Build docs for version 0.2

This commit is contained in:
Nguyễn Gia Phong 2020-05-05 13:41:21 +07:00
parent 616de3a90f
commit a8e83acdf3
11 changed files with 138 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doctrees/contributing.doctree
View File

Binary file not shown.

BIN
doctrees/environment.pickle
View File

Binary file not shown.

BIN
doctrees/reference.doctree
View File

Binary file not shown.

23
html/_sources/contributing.rst.txt
View File

@ -110,6 +110,28 @@ Via Email
In any case, thank you very much for your contributions!
Making a Release
----------------
While this is meant for developers doing a palace release, contributors wishing
to improve the CI/CD may find it helpful.
#. Under the local repository, checkout the ``master`` branch
and sync with the one on GitHub using ``git pull``.
#. Bump the version in ``setup.cfg`` and push to GitHub.
#. Create a source distribution by running ``setup.py sdist``.
The distribution generated by this command is now referred to as ``sdist``.
#. Using twine_, upload the ``sdist`` to PyPI via ``twine upload $sdist``.
#. On GitHub, tag a new release with the ``sdist`` attached.
In the release note, make sure to include all user-facing changes
since the previous release. This will trigger the CD services
to build the wheels and publish them to PyPI.
#. Under the local repository, checkout the ``gh-pages`` branch.
Often, is it necessary to update the credits under the :doc:`copying`
section and review if the :doc:`reference` section needs any change
before running ``make html`` to rebuild to documentation.
#. View the documentation locally then push it to GitHub.
Style Guidelines
----------------
@ -173,5 +195,6 @@ except after the final sentence.
.. _push: https://git-scm.com/docs/git-push
.. _create a pull request:
https://help.github.com/articles/creating-a-pull-request
.. _twine: https://twine.readthedocs.io/en/latest/
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
.. _Octave: https://wiki.octave.org/C%2B%2B_style_guide

8
html/_sources/reference.rst.txt
View File

@ -112,6 +112,10 @@ Sources & Source Groups
Environmental Effects
---------------------
For the sake of brevity, we only document the constraints of each effect's
properties. Further details can be found at OpenAL's `Effect Extension Guide`_
which specifies the purpose and usage of each value.
.. data:: reverb_preset_names
:type: Tuple[str, ...]
@ -122,7 +126,6 @@ Environmental Effects
.. autoclass:: ReverbEffect
:members:
:undoc-members:
.. autoclass:: ChorusEffect
:members:
@ -170,3 +173,6 @@ File I/O Interface
.. autoclass:: FileIO
:members:
.. _Effect Extension Guide:
https://kcat.strangesoft.net/misc-downloads/Effects%20Extension%20Guide.pdf

23
html/contributing.html
View File

@ -143,6 +143,28 @@ We will then review and merge it.</p></li>
<p>In any case, thank you very much for your contributions!</p>
</div>
</div>
<div class="section" id="making-a-release">
<h2>Making a Release<a class="headerlink" href="#making-a-release" title="Permalink to this headline"></a></h2>
<p>While this is meant for developers doing a palace release, contributors wishing
to improve the CI/CD may find it helpful.</p>
<ol class="arabic simple">
<li><p>Under the local repository, checkout the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch
and sync with the one on GitHub using <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span></code>.</p></li>
<li><p>Bump the version in <code class="docutils literal notranslate"><span class="pre">setup.cfg</span></code> and push to GitHub.</p></li>
<li><p>Create a source distribution by running <code class="docutils literal notranslate"><span class="pre">setup.py</span> <span class="pre">sdist</span></code>.
The distribution generated by this command is now referred to as <code class="docutils literal notranslate"><span class="pre">sdist</span></code>.</p></li>
<li><p>Using <a class="reference external" href="https://twine.readthedocs.io/en/latest/">twine</a>, upload the <code class="docutils literal notranslate"><span class="pre">sdist</span></code> to PyPI via <code class="docutils literal notranslate"><span class="pre">twine</span> <span class="pre">upload</span> <span class="pre">$sdist</span></code>.</p></li>
<li><p>On GitHub, tag a new release with the <code class="docutils literal notranslate"><span class="pre">sdist</span></code> attached.
In the release note, make sure to include all user-facing changes
since the previous release. This will trigger the CD services
to build the wheels and publish them to PyPI.</p></li>
<li><p>Under the local repository, checkout the <code class="docutils literal notranslate"><span class="pre">gh-pages</span></code> branch.
Often, is it necessary to update the credits under the <a class="reference internal" href="copying.html"><span class="doc">Copying</span></a>
section and review if the <a class="reference internal" href="reference.html"><span class="doc">Reference</span></a> section needs any change
before running <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code> to rebuild to documentation.</p></li>
<li><p>View the documentation locally then push it to GitHub.</p></li>
</ol>
</div>
<div class="section" id="style-guidelines">
<h2>Style Guidelines<a class="headerlink" href="#style-guidelines" title="Permalink to this headline"></a></h2>
<div class="section" id="python-and-cython">
@ -207,6 +229,7 @@ except after the final sentence.</p>
<li class="toctree-l2"><a class="reference internal" href="#reporting-a-bug">Reporting a Bug</a></li>
<li class="toctree-l2"><a class="reference internal" href="#requesting-a-feature">Requesting a Feature</a></li>
<li class="toctree-l2"><a class="reference internal" href="#submitting-a-patch">Submitting a Patch</a></li>
<li class="toctree-l2"><a class="reference internal" href="#making-a-release">Making a Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="#style-guidelines">Style Guidelines</a></li>
</ul>
</li>

1
html/index.html
View File

@ -67,6 +67,7 @@ for a safe, convenient and pleasurable experience.</p>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#reporting-a-bug">Reporting a Bug</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#requesting-a-feature">Requesting a Feature</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#submitting-a-patch">Submitting a Patch</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#making-a-release">Making a Release</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#style-guidelines">Style Guidelines</a></li>
</ul>
</li>

79
html/reference.html
View File

@ -299,12 +299,13 @@ extension to be available.</p>
<dt id="palace.use_context">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">use_context</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">context</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span><a class="reference internal" href="#palace.Context" title="palace.Context">palace.Context</a><span class="p">]</span></span></em>, <em class="sig-param"><span class="n">thread</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>bool<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#palace.use_context" title="Permalink to this definition"></a></dt>
<dd><p>Make the specified context current for OpenAL operations.</p>
<p>If <cite>thread</cite> is set to <cite>True</cite>, make the context current
<p>This fails silently if the given context has been destroyed.
In case <cite>thread</cite> is not specified, fallback to preference made by
<cite>thread_local</cite>.</p>
<p>If <cite>thread</cite> is <cite>True</cite>, make the context current
for OpenAL operations on the calling thread only.
This requires the non-device-specific as well as the context’s
device <cite>ALC_EXT_thread_local_context</cite> extension to be available.</p>
<p>In case <cite>thread</cite> is not specified, fallback to preference made by
<cite>thread_local</cite>.</p>
</dd></dl>
<dl class="py class">
@ -1289,6 +1290,9 @@ By default <cite>current_context()</cite> is used.</p>
</div>
<div class="section" id="environmental-effects">
<h2>Environmental Effects<a class="headerlink" href="#environmental-effects" title="Permalink to this headline"></a></h2>
<p>For the sake of brevity, we only document the constraints of each effect’s
properties. Further details can be found at OpenAL’s <a class="reference external" href="https://kcat.strangesoft.net/misc-downloads/Effects%20Extension%20Guide.pdf">Effect Extension Guide</a>
which specifies the purpose and usage of each value.</p>
<dl class="py data">
<dt id="palace.reverb_preset_names">
<code class="sig-prename descclassname">palace.</code><code class="sig-name descname">reverb_preset_names</code><em class="property">: Tuple[str, ...]</em><a class="headerlink" href="#palace.reverb_preset_names" title="Permalink to this definition"></a></dt>
@ -1375,117 +1379,140 @@ By default <cite>current_context()</cite> is used.</p></li>
<dl class="py attribute">
<dt id="palace.ReverbEffect.air_absorption_gain_hf">
<code class="sig-name descname">air_absorption_gain_hf</code><a class="headerlink" href="#palace.ReverbEffect.air_absorption_gain_hf" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>High frequency air absorption gain, from 0.892 to 1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.decay_hf_limit">
<code class="sig-name descname">decay_hf_limit</code><a class="headerlink" href="#palace.ReverbEffect.decay_hf_limit" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>High frequency decay limit.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.decay_hf_ratio">
<code class="sig-name descname">decay_hf_ratio</code><a class="headerlink" href="#palace.ReverbEffect.decay_hf_ratio" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>High frequency decay ratio, from 0.1 to 20.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.decay_lf_ratio">
<code class="sig-name descname">decay_lf_ratio</code><a class="headerlink" href="#palace.ReverbEffect.decay_lf_ratio" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Low frequency decay ratio, from 0.1 to 20.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.decay_time">
<code class="sig-name descname">decay_time</code><a class="headerlink" href="#palace.ReverbEffect.decay_time" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Decay time, from 0.1 to 20.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.density">
<code class="sig-name descname">density</code><a class="headerlink" href="#palace.ReverbEffect.density" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Density, from 0.0 to 1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.diffusion">
<code class="sig-name descname">diffusion</code><a class="headerlink" href="#palace.ReverbEffect.diffusion" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Diffusion, from 0.0 to 1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.echo_depth">
<code class="sig-name descname">echo_depth</code><a class="headerlink" href="#palace.ReverbEffect.echo_depth" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Echo depth, from 0.0 to 1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.echo_time">
<code class="sig-name descname">echo_time</code><a class="headerlink" href="#palace.ReverbEffect.echo_time" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Echo time, from 0.075 to 0.25.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.gain">
<code class="sig-name descname">gain</code><a class="headerlink" href="#palace.ReverbEffect.gain" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Gain, from 0.0 to 1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.gain_hf">
<code class="sig-name descname">gain_hf</code><a class="headerlink" href="#palace.ReverbEffect.gain_hf" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>High frequency gain, from 0.0 to 1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.gain_lf">
<code class="sig-name descname">gain_lf</code><a class="headerlink" href="#palace.ReverbEffect.gain_lf" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Low frequency gain, from 0.0 to 1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.hf_reference">
<code class="sig-name descname">hf_reference</code><a class="headerlink" href="#palace.ReverbEffect.hf_reference" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>High frequency reference, from 1000.0 to 20000.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.late_reverb_delay">
<code class="sig-name descname">late_reverb_delay</code><a class="headerlink" href="#palace.ReverbEffect.late_reverb_delay" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Late reverb delay, from 0.0 to 0.1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.late_reverb_gain">
<code class="sig-name descname">late_reverb_gain</code><a class="headerlink" href="#palace.ReverbEffect.late_reverb_gain" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Late reverb gain, from 0.0 to 10.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.late_reverb_pan">
<code class="sig-name descname">late_reverb_pan</code><a class="headerlink" href="#palace.ReverbEffect.late_reverb_pan" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Late reverb as 3D vector of magnitude between 0 and 1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.lf_reference">
<code class="sig-name descname">lf_reference</code><a class="headerlink" href="#palace.ReverbEffect.lf_reference" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Low frequency reference, from 20.0 to 1000.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.modulation_depth">
<code class="sig-name descname">modulation_depth</code><a class="headerlink" href="#palace.ReverbEffect.modulation_depth" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Modulation depth, from 0.0 to 1.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.modulation_time">
<code class="sig-name descname">modulation_time</code><a class="headerlink" href="#palace.ReverbEffect.modulation_time" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Modulation time, from 0.004 to 4.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.reflections_delay">
<code class="sig-name descname">reflections_delay</code><a class="headerlink" href="#palace.ReverbEffect.reflections_delay" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Reflections delay, from 0.0 to 0.3.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.reflections_gain">
<code class="sig-name descname">reflections_gain</code><a class="headerlink" href="#palace.ReverbEffect.reflections_gain" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Reflections gain, from 0.0 to 3.16.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.reflections_pan">
<code class="sig-name descname">reflections_pan</code><a class="headerlink" href="#palace.ReverbEffect.reflections_pan" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Reflections as 3D vector of magnitude between 0 and 1.</p>
</dd></dl>
<dl class="py attribute">
<dt id="palace.ReverbEffect.room_rolloff_factor">
<code class="sig-name descname">room_rolloff_factor</code><a class="headerlink" href="#palace.ReverbEffect.room_rolloff_factor" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Room rolloff factor, from 0.0 to 10.0.</p>
</dd></dl>
<dl class="py method">
<dt id="palace.ReverbEffect.send_auto">

2
html/searchindex.js
View File

File diff suppressed because one or more lines are too long

23
src/contributing.rst
View File

@ -110,6 +110,28 @@ Via Email
In any case, thank you very much for your contributions!
Making a Release
----------------
While this is meant for developers doing a palace release, contributors wishing
to improve the CI/CD may find it helpful.
#. Under the local repository, checkout the ``master`` branch
and sync with the one on GitHub using ``git pull``.
#. Bump the version in ``setup.cfg`` and push to GitHub.
#. Create a source distribution by running ``setup.py sdist``.
The distribution generated by this command is now referred to as ``sdist``.
#. Using twine_, upload the ``sdist`` to PyPI via ``twine upload $sdist``.
#. On GitHub, tag a new release with the ``sdist`` attached.
In the release note, make sure to include all user-facing changes
since the previous release. This will trigger the CD services
to build the wheels and publish them to PyPI.
#. Under the local repository, checkout the ``gh-pages`` branch.
Often, is it necessary to update the credits under the :doc:`copying`
section and review if the :doc:`reference` section needs any change
before running ``make html`` to rebuild to documentation.
#. View the documentation locally then push it to GitHub.
Style Guidelines
----------------
@ -173,5 +195,6 @@ except after the final sentence.
.. _push: https://git-scm.com/docs/git-push
.. _create a pull request:
https://help.github.com/articles/creating-a-pull-request
.. _twine: https://twine.readthedocs.io/en/latest/
.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
.. _Octave: https://wiki.octave.org/C%2B%2B_style_guide

8
src/reference.rst
View File

@ -112,6 +112,10 @@ Sources & Source Groups
Environmental Effects
---------------------
For the sake of brevity, we only document the constraints of each effect's
properties. Further details can be found at OpenAL's `Effect Extension Guide`_
which specifies the purpose and usage of each value.
.. data:: reverb_preset_names
:type: Tuple[str, ...]
@ -122,7 +126,6 @@ Environmental Effects
.. autoclass:: ReverbEffect
:members:
:undoc-members:
.. autoclass:: ChorusEffect
:members:
@ -170,3 +173,6 @@ File I/O Interface
.. autoclass:: FileIO
:members:
.. _Effect Extension Guide:
https://kcat.strangesoft.net/misc-downloads/Effects%20Extension%20Guide.pdf