Docs

2025-12-31 08:50:41 +00:00 · 2022-11-24 22:34:49 -08:00
parent d5b6f15e28
commit df4cc8822e
7 changed files with 12 additions and 5 deletions
--- 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

--- 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:
--- a/docs/source/metadata_scopes/adm.rst
+++ b/docs/source/metadata_scopes/adm.rst
--- a/docs/source/metadata_scopes/bext.rst
+++ b/docs/source/metadata_scopes/bext.rst
--- a/docs/source/metadata_scopes/dolby.rst
+++ b/docs/source/metadata_scopes/dolby.rst
--- a/docs/source/metadata_scopes/info.rst
+++ b/docs/source/metadata_scopes/info.rst
--- a/docs/source/metadata_scopes/ixml.rst
+++ b/docs/source/metadata_scopes/ixml.rst