From 6fe6126f3a2eeb915a16d94f68093e2776eebbd7 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Wed, 16 Nov 2022 19:15:51 -0800 Subject: [PATCH] Updated docs --- docs/classes.rst | 18 ++++++++++++++++++ docs/conf.py | 1 + docs/index.rst | 19 ++----------------- 3 files changed, 21 insertions(+), 17 deletions(-) create mode 100644 docs/classes.rst diff --git a/docs/classes.rst b/docs/classes.rst new file mode 100644 index 0000000..0a44820 --- /dev/null +++ b/docs/classes.rst @@ -0,0 +1,18 @@ +Other wavinfo Classes +=============== + + +.. autoclass:: wavinfo.wave_reader.WavInfoReader + :members: + + .. automethod:: __init__ + + +.. autoclass:: wavinfo.wave_reader.WavAudioFormat + :members: + +.. autoclass:: wavinfo.wave_reader.WavDataDescriptor + :members: + + + diff --git a/docs/conf.py b/docs/conf.py index acb9f2a..1ae4559 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,6 +15,7 @@ import os import sys sys.path.insert(0, os.path.abspath('..')) +print(sys.path) # -- Project information ----------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index d9b86c7..31197f7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,30 +6,15 @@ Welcome to wavinfo's documentation! =================================== - -.. module:: wavinfo - -.. autoclass:: WavInfoReader - :members: - - .. automethod:: __init__ - - -.. autoclass:: wavinfo.wave_reader.WavAudioFormat - :members: - -.. autoclass:: wavinfo.wave_reader.WavDataDescriptor - :members: - - .. toctree:: :maxdepth: 2 :caption: Notes: - + metadata_scopes/bext.rst metadata_scopes/ixml.rst metadata_scopes/info.rst + classes Indices and tables