diff options
Diffstat (limited to 'extern/audaspace/bindings/doc')
-rw-r--r-- | extern/audaspace/bindings/doc/device.rst | 1 | ||||
-rw-r--r-- | extern/audaspace/bindings/doc/handle.rst | 1 | ||||
-rw-r--r-- | extern/audaspace/bindings/doc/index.rst | 3 | ||||
-rw-r--r-- | extern/audaspace/bindings/doc/sequence.rst | 1 | ||||
-rw-r--r-- | extern/audaspace/bindings/doc/sequence_entry.rst | 1 | ||||
-rw-r--r-- | extern/audaspace/bindings/doc/sound.rst | 1 | ||||
-rw-r--r-- | extern/audaspace/bindings/doc/tutorials.rst | 2 |
7 files changed, 8 insertions, 2 deletions
diff --git a/extern/audaspace/bindings/doc/device.rst b/extern/audaspace/bindings/doc/device.rst index fd6b334022c..d6f49bd7407 100644 --- a/extern/audaspace/bindings/doc/device.rst +++ b/extern/audaspace/bindings/doc/device.rst @@ -4,4 +4,5 @@ Device .. currentmodule:: aud .. autoclass:: Device :members: + :noindex: diff --git a/extern/audaspace/bindings/doc/handle.rst b/extern/audaspace/bindings/doc/handle.rst index aceedbca3a6..1d118e1ef62 100644 --- a/extern/audaspace/bindings/doc/handle.rst +++ b/extern/audaspace/bindings/doc/handle.rst @@ -4,4 +4,5 @@ Handle .. currentmodule:: aud .. autoclass:: Handle :members: + :noindex: diff --git a/extern/audaspace/bindings/doc/index.rst b/extern/audaspace/bindings/doc/index.rst index b8a26822949..cc6a543067d 100644 --- a/extern/audaspace/bindings/doc/index.rst +++ b/extern/audaspace/bindings/doc/index.rst @@ -7,6 +7,7 @@ Welcome to audaspace's documentation! ===================================== .. automodule:: aud + :no-members: 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. @@ -18,7 +19,7 @@ This documentation is valid for both the Python and C bindings of audaspace. If Classes: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 device sound diff --git a/extern/audaspace/bindings/doc/sequence.rst b/extern/audaspace/bindings/doc/sequence.rst index 16fcb00f4dc..51aef1a1d37 100644 --- a/extern/audaspace/bindings/doc/sequence.rst +++ b/extern/audaspace/bindings/doc/sequence.rst @@ -4,4 +4,5 @@ Sequence .. currentmodule:: aud .. autoclass:: Sequence :members: + :noindex: diff --git a/extern/audaspace/bindings/doc/sequence_entry.rst b/extern/audaspace/bindings/doc/sequence_entry.rst index 0a3d83388e9..797b950dcdd 100644 --- a/extern/audaspace/bindings/doc/sequence_entry.rst +++ b/extern/audaspace/bindings/doc/sequence_entry.rst @@ -4,4 +4,5 @@ Sequence Entry .. currentmodule:: aud .. autoclass:: SequenceEntry :members: + :noindex: diff --git a/extern/audaspace/bindings/doc/sound.rst b/extern/audaspace/bindings/doc/sound.rst index 2f14721cf3a..d88c113eead 100644 --- a/extern/audaspace/bindings/doc/sound.rst +++ b/extern/audaspace/bindings/doc/sound.rst @@ -4,4 +4,5 @@ Sound .. currentmodule:: aud .. autoclass:: Sound :members: + :noindex: diff --git a/extern/audaspace/bindings/doc/tutorials.rst b/extern/audaspace/bindings/doc/tutorials.rst index 2a0e7541861..919c9083fc8 100644 --- a/extern/audaspace/bindings/doc/tutorials.rst +++ b/extern/audaspace/bindings/doc/tutorials.rst @@ -40,7 +40,7 @@ and create a :func:`aud.Sound.sine` signal with a frequency of 440 Hz. sine = aud.Sound.sine(440) .. note:: At this point nothing is playing back yet, -:class:`aud.Sound` objects are just descriptions of sounds. + :class:`aud.Sound` objects are just descriptions of sounds. However instead of a sine wave, we would like to have a square wave to produce a more retro gaming sound. We could of course use the |