tmp
[blender.git] / extern / audaspace / bindings / doc / index.rst
1 .. audaspace documentation master file, created by
2    sphinx-quickstart on Tue Sep  9 01:48:48 2014.
3    You can adapt this file completely to your liking, but it should at least
4    contain the root `toctree` directive.
5
6 Welcome to audaspace's documentation!
7 =====================================
8
9 .. automodule:: aud
10
11 This documentation is valid for both the Python and C bindings of audaspace. If you are looking for installation instructions check the `C++ API documentation <../index.html>`_. As C is not an object oriented language everything is accessible via functions where the first paramter is always the object. For methods these are named as ``AUD_ClassName_method()`` and properties are accessed via ``AUD_ClassName_property_get/set()``. Python users simply ``import aud`` to access the library.
12
13 .. toctree::
14    :maxdepth: 2
15
16    tutorials
17
18 Classes:
19
20 .. toctree::
21    :maxdepth: 2
22
23    device
24    sound
25    handle
26    sequence
27    sequence_entry
28
29 Indices and tables
30 ==================
31
32 * :ref:`genindex`
33 * :ref:`modindex`
34 * :ref:`search`
35