From df4cc8822ee489f1e49a944083f885cba265b2d5 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Thu, 24 Nov 2022 22:34:49 -0800 Subject: [PATCH] Docs --- docs/source/index.rst | 15 ++++++++++----- docs/source/quickstart.rst | 2 ++ docs/source/{metadata_scopes => scopes}/adm.rst | 0 docs/source/{metadata_scopes => scopes}/bext.rst | 0 docs/source/{metadata_scopes => scopes}/dolby.rst | 0 docs/source/{metadata_scopes => scopes}/info.rst | 0 docs/source/{metadata_scopes => scopes}/ixml.rst | 0 7 files changed, 12 insertions(+), 5 deletions(-) rename docs/source/{metadata_scopes => scopes}/adm.rst (100%) rename docs/source/{metadata_scopes => scopes}/bext.rst (100%) rename docs/source/{metadata_scopes => scopes}/dolby.rst (100%) rename docs/source/{metadata_scopes => scopes}/info.rst (100%) rename docs/source/{metadata_scopes => scopes}/ixml.rst (100%) diff --git a/docs/source/index.rst b/docs/source/index.rst index 9f628be..79ce1a5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,16 +6,21 @@ Welcome to wavinfo's documentation! =================================== +The `wavinfo` package allows you to probe WAVE and RF64/WAVE files and +extract extended metadata, with an emphasis on film, video and professional +music production metadata. + + .. toctree:: :maxdepth: 1 :caption: Notes quickstart - metadata_scopes/adm.rst - metadata_scopes/bext.rst - metadata_scopes/dolby.rst - metadata_scopes/info.rst - metadata_scopes/ixml.rst + scopes/bext.rst + scopes/ixml.rst + scopes/adm.rst + scopes/dolby.rst + scopes/info.rst classes diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index 305248a..37f4b13 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -11,6 +11,8 @@ wavinfo Quickstart info = wavinfo.WavInfoReader(path) +.. module:: wavinfo + :noindex: .. autoclass:: wavinfo.wave_reader.WavInfoReader :members: diff --git a/docs/source/metadata_scopes/adm.rst b/docs/source/scopes/adm.rst similarity index 100% rename from docs/source/metadata_scopes/adm.rst rename to docs/source/scopes/adm.rst diff --git a/docs/source/metadata_scopes/bext.rst b/docs/source/scopes/bext.rst similarity index 100% rename from docs/source/metadata_scopes/bext.rst rename to docs/source/scopes/bext.rst diff --git a/docs/source/metadata_scopes/dolby.rst b/docs/source/scopes/dolby.rst similarity index 100% rename from docs/source/metadata_scopes/dolby.rst rename to docs/source/scopes/dolby.rst diff --git a/docs/source/metadata_scopes/info.rst b/docs/source/scopes/info.rst similarity index 100% rename from docs/source/metadata_scopes/info.rst rename to docs/source/scopes/info.rst diff --git a/docs/source/metadata_scopes/ixml.rst b/docs/source/scopes/ixml.rst similarity index 100% rename from docs/source/metadata_scopes/ixml.rst rename to docs/source/scopes/ixml.rst