Documentation

2026-01-02 01:40:42 +00:00 · 2019-01-03 18:24:44 -08:00
parent 477c71830e
commit 9e16f6ab1f
4 changed files with 282 additions and 0 deletions
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -0,0 +1,44 @@
+.. wavinfo documentation master file, created by
+   sphinx-quickstart on Thu Jan  3 17:09:28 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to wavinfo's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. module:: wavinfo
+
+.. autoclass:: WavInfoReader
+
+   .. automethod:: __init__
+   
+   .. attribute:: fmt
+
+      Audio format.
+
+   .. attribute:: data
+
+      Statistics on the audio data.
+
+   .. attribute:: bext
+
+      Broadcast-WAV metadata.
+
+   .. attribute:: ixml
+      
+      iXML metadata.
+
+   .. attribute:: info
+
+      RIFF INFO metadata.
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`