~cnx/palace

ref: 1ba92b7c5054be58c69bfd06436f01460e964f06 palace/docs/source/index.rst -rw-r--r-- 1.3 KiB
1ba92b7c — MostDeadDeveloper Use RTD theme for HTML documentation (fix GH-119) 1 year, 2 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Overview
========

Pythonic Audio Library and Codecs Environment provides common higher-level API
for audio rendering using OpenAL:

* 3D positional rendering, with HRTF_ support for stereo systems
* Environmental effects: reverb, atmospheric air absorption,
  sound occlusion and obstruction
* Out-of-the-box codec support: FLAC, MP3, Ogg Vorbis, Opus, WAV, AIFF, etc.

Palace wraps around the C++ interface alure_ using Cython_ for a safe and
convenient interface with type hinting, data descriptors and context managers,
following :pep:`8#naming-conventions` (``PascalCase.snake_case``).

.. toctree::
   :caption: Table of Contents
   :maxdepth: 2

   installation
   tutorial/index
   reference/index
   design
   contributing
   copying

.. toctree::
   :caption: Quick Navigation
   :hidden:

   Python Package Index <https://pypi.org/project/palace/>
   Travis CI Build <https://travis-ci.com/github/McSinyx/palace>
   AppVeyor Build <https://ci.appveyor.com/project/McSinyx/palace>
   GitHub Repository <https://github.com/McSinyx/palace>
   Matrix Chat Room <https://matrix.to/#/#palace-dev:matrix.org>

Indices and Tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _HRTF: https://en.wikipedia.org/wiki/Head-related_transfer_function
.. _alure: https://github.com/kcat/alure
.. _Cython: https://cython.org