From f06c9f43d4160641913c20f5abd5927c94283154 Mon Sep 17 00:00:00 2001 From: dtomlinson Date: Sun, 8 Mar 2020 23:27:42 +0000 Subject: [PATCH] adding api documentation --- .../modules/musicbrainzapi.api.lyrics.rst | 37 +++++++++++++------ docs/source/modules/musicbrainzapi.api.rst | 2 +- 2 files changed, 27 insertions(+), 12 deletions(-) diff --git a/docs/source/modules/musicbrainzapi.api.lyrics.rst b/docs/source/modules/musicbrainzapi.api.lyrics.rst index 38ae92d..28bda3e 100644 --- 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: diff --git a/docs/source/modules/musicbrainzapi.api.rst b/docs/source/modules/musicbrainzapi.api.rst index fc152e4..d0080a9 100644 --- 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 ==========