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

Add project overview and fix more typos

This commit is contained in:
Nguyễn Gia Phong 2020-05-03 11:58:15 +07:00
parent 064aeb7099
commit 616de3a90f
25 changed files with 273 additions and 233 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/copying.doctree
View File

Binary file not shown.

BIN
doctrees/environment.pickle
View File

Binary file not shown.

BIN
doctrees/index.doctree
View File

Binary file not shown.

BIN
doctrees/installation.doctree
View File

Binary file not shown.

2
html/.buildinfo
View File

@ -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: e4dd2ac7e3904dfb6fca2de3ac852f68
config: 7b02f7ca4a94725377fc4fed78985519
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@ -10,7 +10,7 @@ Getting Involved
First of all, thank you for using and contributing to palace! We welcome
all forms of contribution, and `the mo the merier`_. By saying this, we also
mean that we much prefer receiving many small and self-contained bug reports,
feature requests and patches then one giant one. There is no limit for
feature requests and patches than a giant one. There is no limit for
the number of contributions one may or should make. While it may seem
appealing to be able to dump all thoughts and feelings into one ticket,
it would be more difficult for us to keep track of the progress.

6
html/_sources/copying.rst.txt
View File

@ -47,9 +47,9 @@ Palace would never have seen the light of day without the help from
the developers of Alure_ and Cython_ who promptly gave detail answers
and made quick fixes to all of our problems.
The wheels are build using cibuildwheel_, which made building wheels for
extension modules much less of a pain in the ass. `Travis CI`_ and AppVeyor_
kindly provides there services free of charge for automated CI/CD.
The wheels are build using cibuildwheel_, which made building extension modules
much less of a painful experience. `Travis CI`_ and AppVeyor_ kindly provides
their services free of charge for automated CI/CD.
This documentation is generated using Sphinx_, whose maintainer responses
extreamly quickly to obsolete Cython-related issues.

10
html/_sources/index.rst.txt
View File

@ -1,9 +1,15 @@
Welcome to our palace!
======================
Pythonic Audio Library and Codecs Environment provides common higher-level API
for audio rendering using OpenAL. It wraps around the C++ interface alure_
for 3D positional rendering, environmental effects and out-of-the-box
codec support, while using Cython to provide a modern interface with
type hinting, data descriptors, context managers and ``snake_case``
for a safe, convenient and pleasurable experience.
.. toctree::
:maxdepth: 2
:caption: Contents:
installation
reference
@ -18,3 +24,5 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _alure: https://github.com/kcat/alure

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

@ -4,7 +4,8 @@ Installation
Prerequisites
-------------
Palace requires Python 3.6 for runtime and pip_ for installation.
Palace requires CPython_ version 3.6 or above for runtime
and pip_ for installation.
Via PyPI
--------
@ -22,12 +23,15 @@ From source
Aside from the build dependencies listed in ``pyproject.toml``,
one will additionally need compatible Python headers, alure_,
a C++14 compiler, CMake 2.6+ (and probably ``git`` for fetching the source).
a C++14 compiler, CMake_ 2.6+ (and probably git_ for fetching the source).
Palace can then be compiled and installed by running::
git clone https://github.com/McSinyx/palace.git
pip install palace/
.. _CPython: https://www.python.org/
.. _pip: https://pip.pypa.io/en/latest/
.. _GH-1: https://github.com/McSinyx/palace/issues/1
.. _alure: https://github.com/kcat/alure
.. _CMake: https://cmake.org/
.. _git: https://git-scm.com/

53
html/contributing.html
View File

@ -45,7 +45,7 @@ and bug reports sent via email.</p>
<p>First of all, thank you for using and contributing to palace! We welcome
all forms of contribution, and <a class="reference external" href="https://www.phrases.org.uk/meanings/the-more-the-merrier.html">the mo the merier</a>. By saying this, we also
mean that we much prefer receiving many small and self-contained bug reports,
feature requests and patches then one giant one. There is no limit for
feature requests and patches than a giant one. There is no limit for
the number of contributions one may or should make. While it may seem
appealing to be able to dump all thoughts and feelings into one ticket,
it would be more difficult for us to keep track of the progress.</p>
@ -198,17 +198,7 @@ except after the final sentence.</p>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">palace</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
@ -222,16 +212,31 @@ except after the final sentence.</p>
</li>
<li class="toctree-l1"><a class="reference internal" href="copying.html">Copying</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<h3>Quick Navigation</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="design.html" title="previous chapter">Design Principles</a></li>
<li>Next: <a href="copying.html" title="next chapter">Copying</a></li>
</ul></li>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
@ -242,14 +247,6 @@ except after the final sentence.</p>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>

56
html/copying.html
View File

@ -110,9 +110,9 @@ the build machine, which is similar to static linking:</p>
<p>Palace would never have seen the light of day without the help from
the developers of <a class="reference external" href="https://github.com/kcat/alure">Alure</a> and <a class="reference external" href="https://cython.org/">Cython</a> who promptly gave detail answers
and made quick fixes to all of our problems.</p>
<p>The wheels are build using <a class="reference external" href="https://cibuildwheel.readthedocs.io/en/stable/">cibuildwheel</a>, which made building wheels for
extension modules much less of a pain in the ass. <a class="reference external" href="https://travis-ci.com/">Travis CI</a> and <a class="reference external" href="https://www.appveyor.com/">AppVeyor</a>
kindly provides there services free of charge for automated CI/CD.</p>
<p>The wheels are build using <a class="reference external" href="https://cibuildwheel.readthedocs.io/en/stable/">cibuildwheel</a>, which made building extension modules
much less of a painful experience. <a class="reference external" href="https://travis-ci.com/">Travis CI</a> and <a class="reference external" href="https://www.appveyor.com/">AppVeyor</a> kindly provides
their services free of charge for automated CI/CD.</p>
<p>This documentation is generated using <a class="reference external" href="https://www.sphinx-doc.org/en/master/">Sphinx</a>, whose maintainer responses
extreamly quickly to obsolete Cython-related issues.</p>
</div>
@ -125,17 +125,7 @@ extreamly quickly to obsolete Cython-related issues.</p>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">palace</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
@ -147,15 +137,31 @@ extreamly quickly to obsolete Cython-related issues.</p>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<h3>Quick Navigation</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="contributing.html" title="previous chapter">Getting Involved</a></li>
</ul></li>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
@ -166,14 +172,6 @@ extreamly quickly to obsolete Cython-related issues.</p>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>

51
html/design.html
View File

@ -191,17 +191,7 @@ implementation as a pure Python class and <a class="reference internal" href="#g
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">palace</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
@ -214,16 +204,31 @@ implementation as a pure Python class and <a class="reference internal" href="#g
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Getting Involved</a></li>
<li class="toctree-l1"><a class="reference internal" href="copying.html">Copying</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<h3>Quick Navigation</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="reference.html" title="previous chapter">Reference</a></li>
<li>Next: <a href="contributing.html" title="next chapter">Getting Involved</a></li>
</ul></li>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
@ -234,14 +239,6 @@ implementation as a pure Python class and <a class="reference internal" href="#g
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>

49
html/genindex.html
View File

@ -629,17 +629,7 @@
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">palace</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
@ -647,14 +637,31 @@
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Getting Involved</a></li>
<li class="toctree-l1"><a class="reference internal" href="copying.html">Copying</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<h3>Quick Navigation</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
@ -665,14 +672,6 @@
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>

57
html/index.html
View File

@ -33,8 +33,13 @@
<div class="section" id="welcome-to-our-palace">
<h1>Welcome to our palace!<a class="headerlink" href="#welcome-to-our-palace" title="Permalink to this headline"></a></h1>
<p>Pythonic Audio Library and Codecs Environment provides common higher-level API
for audio rendering using OpenAL. It wraps around the C++ interface <a class="reference external" href="https://github.com/kcat/alure">alure</a>
for 3D positional rendering, environmental effects and out-of-the-box
codec support, while using Cython to provide a modern interface with
type hinting, data descriptors, context managers and <code class="docutils literal notranslate"><span class="pre">snake_case</span></code>
for a safe, convenient and pleasurable experience.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#prerequisites">Prerequisites</a></li>
@ -89,17 +94,7 @@
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">palace</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
@ -107,15 +102,31 @@
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Getting Involved</a></li>
<li class="toctree-l1"><a class="reference internal" href="copying.html">Copying</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<h3>Quick Navigation</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="installation.html" title="next chapter">Installation</a></li>
</ul></li>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
@ -126,14 +137,6 @@
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>

56
html/installation.html
View File

@ -36,7 +36,8 @@
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<p>Palace requires Python 3.6 for runtime and <a class="reference external" href="https://pip.pypa.io/en/latest/">pip</a> for installation.</p>
<p>Palace requires <a class="reference external" href="https://www.python.org/">CPython</a> version 3.6 or above for runtime
and <a class="reference external" href="https://pip.pypa.io/en/latest/">pip</a> for installation.</p>
</div>
<div class="section" id="via-pypi">
<h2>Via PyPI<a class="headerlink" href="#via-pypi" title="Permalink to this headline"></a></h2>
@ -52,7 +53,7 @@ please see <a class="reference external" href="https://github.com/McSinyx/palace
<h2>From source<a class="headerlink" href="#from-source" title="Permalink to this headline"></a></h2>
<p>Aside from the build dependencies listed in <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code>,
one will additionally need compatible Python headers, <a class="reference external" href="https://github.com/kcat/alure">alure</a>,
a C++14 compiler, CMake 2.6+ (and probably <code class="docutils literal notranslate"><span class="pre">git</span></code> for fetching the source).
a C++14 compiler, <a class="reference external" href="https://cmake.org/">CMake</a> 2.6+ (and probably <a class="reference external" href="https://git-scm.com/">git</a> for fetching the source).
Palace can then be compiled and installed by running:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">McSinyx</span><span class="o">/</span><span class="n">palace</span><span class="o">.</span><span class="n">git</span>
<span class="n">pip</span> <span class="n">install</span> <span class="n">palace</span><span class="o">/</span>
@ -68,17 +69,7 @@ Palace can then be compiled and installed by running:</p>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">palace</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
@ -91,16 +82,31 @@ Palace can then be compiled and installed by running:</p>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Getting Involved</a></li>
<li class="toctree-l1"><a class="reference internal" href="copying.html">Copying</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<h3>Quick Navigation</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to our palace!</a></li>
<li>Next: <a href="reference.html" title="next chapter">Reference</a></li>
</ul></li>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
@ -111,14 +117,6 @@ Palace can then be compiled and installed by running:</p>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>

51
html/reference.html
View File

@ -1884,17 +1884,7 @@ or 2 (move relative to end of file).</p></li>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">palace</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Reference</a><ul>
@ -1911,16 +1901,31 @@ or 2 (move relative to end of file).</p></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Getting Involved</a></li>
<li class="toctree-l1"><a class="reference internal" href="copying.html">Copying</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<h3>Quick Navigation</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="installation.html" title="previous chapter">Installation</a></li>
<li>Next: <a href="design.html" title="next chapter">Design Principles</a></li>
</ul></li>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
@ -1931,14 +1936,6 @@ or 2 (move relative to end of file).</p></li>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>

49
html/search.html
View File

@ -63,17 +63,7 @@
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">palace</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
@ -81,22 +71,31 @@
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Getting Involved</a></li>
<li class="toctree-l1"><a class="reference internal" href="copying.html">Copying</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<h3>Quick Navigation</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>

2
html/searchindex.js
View File

File diff suppressed because one or more lines are too long

25
src/_templates/quicknav.html Normal file
View File

@ -0,0 +1,25 @@
<h3>Quick Navigation</h3>
<ul>
<li class="toctree-l1">
<a class="reference external" href="https://pypi.org/project/palace/">
Python Package Index
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://travis-ci.com/github/McSinyx/palace">
Travis CI Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external"
href="https://ci.appveyor.com/project/McSinyx/palace">
AppVeyor Build
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/McSinyx/palace">
GitHub Repository
</a>
</li>
</ul>

3
src/conf.py
View File

@ -51,6 +51,9 @@ exclude_patterns = []
#
html_theme = 'alabaster'
html_sidebars = {
'**': ['globaltoc.html', 'quicknav.html', 'searchbox.html']}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".

2
src/contributing.rst
View File

@ -10,7 +10,7 @@ Getting Involved
First of all, thank you for using and contributing to palace! We welcome
all forms of contribution, and `the mo the merier`_. By saying this, we also
mean that we much prefer receiving many small and self-contained bug reports,
feature requests and patches then one giant one. There is no limit for
feature requests and patches than a giant one. There is no limit for
the number of contributions one may or should make. While it may seem
appealing to be able to dump all thoughts and feelings into one ticket,
it would be more difficult for us to keep track of the progress.

6
src/copying.rst
View File

@ -47,9 +47,9 @@ Palace would never have seen the light of day without the help from
the developers of Alure_ and Cython_ who promptly gave detail answers
and made quick fixes to all of our problems.
The wheels are build using cibuildwheel_, which made building wheels for
extension modules much less of a pain in the ass. `Travis CI`_ and AppVeyor_
kindly provides there services free of charge for automated CI/CD.
The wheels are build using cibuildwheel_, which made building extension modules
much less of a painful experience. `Travis CI`_ and AppVeyor_ kindly provides
their services free of charge for automated CI/CD.
This documentation is generated using Sphinx_, whose maintainer responses
extreamly quickly to obsolete Cython-related issues.

10
src/index.rst
View File

@ -1,9 +1,15 @@
Welcome to our palace!
======================
Pythonic Audio Library and Codecs Environment provides common higher-level API
for audio rendering using OpenAL. It wraps around the C++ interface alure_
for 3D positional rendering, environmental effects and out-of-the-box
codec support, while using Cython to provide a modern interface with
type hinting, data descriptors, context managers and ``snake_case``
for a safe, convenient and pleasurable experience.
.. toctree::
:maxdepth: 2
:caption: Contents:
installation
reference
@ -18,3 +24,5 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _alure: https://github.com/kcat/alure

8
src/installation.rst
View File

@ -4,7 +4,8 @@ Installation
Prerequisites
-------------
Palace requires Python 3.6 for runtime and pip_ for installation.
Palace requires CPython_ version 3.6 or above for runtime
and pip_ for installation.
Via PyPI
--------
@ -22,12 +23,15 @@ From source
Aside from the build dependencies listed in ``pyproject.toml``,
one will additionally need compatible Python headers, alure_,
a C++14 compiler, CMake 2.6+ (and probably ``git`` for fetching the source).
a C++14 compiler, CMake_ 2.6+ (and probably git_ for fetching the source).
Palace can then be compiled and installed by running::
git clone https://github.com/McSinyx/palace.git
pip install palace/
.. _CPython: https://www.python.org/
.. _pip: https://pip.pypa.io/en/latest/
.. _GH-1: https://github.com/McSinyx/palace/issues/1
.. _alure: https://github.com/kcat/alure
.. _CMake: https://cmake.org/
.. _git: https://git-scm.com/