Merge pull request #19 from joextodd/constants-docs

Add constants to docs
joextodd · Apr 6, 2018 · 2d831a8 · 2d831a8
2 parents 414802b + 6eb35bf
commit 2d831a8
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 3 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -1,9 +1,6 @@
 [run]
 omit =
     *__init__.py
-    .tox/*
-
 [report]
 omit =
     *__init__.py
-    .tox/*
diff --git a/docs/constants.rst b/docs/constants.rst
@@ -0,0 +1,40 @@
+Backends
+--------
+
+===================================  ===============================================================
+Value                                Backend Description
+===================================  ===============================================================
+pysoundio.SoundIoBackendJack         JACK Audio
+pysoundio.SoundIoBackendPulseAudio   Pulse Audio
+pysoundio.SoundIoBackendAlsa         ALSA Audio
+pysoundio.SoundIoBackendCoreAudio    Core Audio
+pysoundio.SoundIoBackendWasapi       WASAPI Audio
+pysoundio.SoundIoBackendDummy        Dummy backend
+===================================  ===============================================================
+
+
+Formats
+-------
+
+=================================  ====================================================================
+Value                              Format Description
+=================================  ====================================================================
+pysoundio.SoundIoFormatS8          Signed 8 bit
+pysoundio.SoundIoFormatU8          Unsigned 8 bit
+pysoundio.SoundIoFormatS16LE       Signed 16 bit Little Endian
+pysoundio.SoundIoFormatS16BE       Signed 16 bit Big Endian
+pysoundio.SoundIoFormatU16LE       Unsigned 16 bit Little Endian
+pysoundio.SoundIoFormatU16BE       Unsigned 16 bit Little Endian
+pysoundio.SoundIoFormatS24LE       Signed 24 bit Little Endian using low three bytes in 32-bit word
+pysoundio.SoundIoFormatS24BE       Signed 24 bit Big Endian using low three bytes in 32-bit word
+pysoundio.SoundIoFormatU24LE       Unsigned 24 bit Little Endian using low three bytes in 32-bit word
+pysoundio.SoundIoFormatU24BE       Unsigned 24 bit Big Endian using low three bytes in 32-bit word
+pysoundio.SoundIoFormatS32LE       Signed 32 bit Little Endian
+pysoundio.SoundIoFormatS32BE       Signed 32 bit Big Endian
+pysoundio.SoundIoFormatU32LE       Unsigned 32 bit Little Endian
+pysoundio.SoundIoFormatU32BE       Unsigned 32 bit Big Endian
+pysoundio.SoundIoFormatFloat32LE   Float 32 bit Little Endian, Range -1.0 to 1.0
+pysoundio.SoundIoFormatFloat32BE   Float 32 bit Big Endian, Range -1.0 to 1.0
+pysoundio.SoundIoFormatFloat64LE   Float 64 bit Little Endian, Range -1.0 to 1.0
+pysoundio.SoundIoFormatFloat64BE   Float 64 bit Big Endian, Range -1.0 to 1.0
+=================================  ====================================================================
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,8 @@
 
 .. include:: ../CONTRIBUTING.rst
 
+.. include:: ./constants.rst
+
 
 API Reference
 -------------