diff --git a/docs/source/conf.py b/docs/source/conf.py index c5992ac..37a5689 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,6 +39,7 @@ extensions = [ 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx_click.ext', + 'sphinx.ext.intersphinx' ] # -- Napoleon Settings ----------------------------------------------------- @@ -60,7 +61,7 @@ autodoc_member_order = 'bysource' templates_path = ['_templates'] # The master toctree document. -master_doc = 'introduction' +master_doc = 'index' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 0e2138c..ac73fbe 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -1,3 +1,13 @@ +============= Introduction ============= +##### +Test +##### + +testing + +test code:: + + some test code diff --git a/docs/source/toc.rst b/docs/source/toc.rst index e4796b1..c5feb52 100644 --- a/docs/source/toc.rst +++ b/docs/source/toc.rst @@ -1,5 +1,9 @@ .. toctree:: - :maxdepth: 1 + + self + +.. toctree:: + :maxdepth: 2 :caption: Overview :titlesonly: @@ -7,14 +11,14 @@ changelog .. toctree:: - :maxdepth: 4 + :maxdepth: 2 :caption: Modules :titlesonly: modules/musicbrainzapi.rst .. toctree:: - :maxdepth: 4 + :maxdepth: 2 :caption: Submodules :titlesonly: diff --git a/src/musicbrainzapi/api/lyrics/director.py b/src/musicbrainzapi/api/lyrics/director.py index b44698b..58a5568 100644 --- a/src/musicbrainzapi/api/lyrics/director.py +++ b/src/musicbrainzapi/api/lyrics/director.py @@ -15,6 +15,22 @@ class LyricsClickDirector: def __init__(self) -> None: self._builder = None + @staticmethod + def _get_product(builder_inst: LyricsBuilder) -> Lyrics: + """Returns the constructed Lyrics object + + Parameters + ---------- + builder_inst : LyricsBuilder + Builder class for Lyrics object + + Returns + ------- + Lyrics + Lyrics object + """ + return builder_inst._product + @property def builder(self) -> LyricsBuilder: return self._builder @@ -156,19 +172,3 @@ class LyricsClickDirector: self.builder._product.show_summary() self.builder._product.show_summary_statistics(group_by='year') return self - - @staticmethod - def _get_product(builder_inst: LyricsBuilder) -> Lyrics: - """Returns the constructed Lyrics object - - Parameters - ---------- - builder_inst : LyricsBuilder - Builder class for Lyrics object - - Returns - ------- - Lyrics - Lyrics object - """ - return builder_inst._product