adding api documentation

2020-03-08 23:27:42 +00:00
parent 199302afb3
commit f06c9f43d4
2 changed files with 27 additions and 12 deletions
--- a/docs/source/modules/musicbrainzapi.api.lyrics.rst
+++ b/docs/source/modules/musicbrainzapi.api.lyrics.rst
@@ -1,14 +1,29 @@
-musicbrainzapi.api.lyrics
--------------------------------------------------------------------------
+musicbrainzapi.api.lyrics package
+=================================

-.. automodule:: musicbrainzapi.api.lyrics
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
+.. autmodule:: musicbrainzapi.api.lyrics
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:

-.. toctree::
+Submodules
+==========

-   musicbrainzapi.api.lyrics.builder
-   musicbrainzapi.api.lyrics.concrete_builder
-   musicbrainzapi.api.lyrics.director
+.. automodule:: musicbrainzapi.api.lyrics.builder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
+
+.. automodule:: musicbrainzapi.api.lyrics.concrete_builder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
+
+.. automodule:: musicbrainzapi.api.lyrics.director
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members:
--- a/docs/source/modules/musicbrainzapi.api.rst
+++ b/docs/source/modules/musicbrainzapi.api.rst
@@ -11,7 +11,7 @@ Subpackages
 ===========

 .. toctree::
-    musicbrainzapi.lyrics
+    musicbrainzapi.api.lyrics

 Submodules
 ==========