updating latest documentation

2020-03-09 01:15:20 +00:00
parent 3fecf9d723
commit 8fcb0d8704
11 changed files with 19 additions and 82 deletions
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -89,6 +89,7 @@ html_theme_options = {
    'collapse_navigation': True,
    'display_version': True,
    'prev_next_buttons_location': 'both',
+    'navigation_depth': -1,
    #'navigation_depth': 3,
 }

--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -12,6 +12,7 @@ Table of Contents

 .. toctree::
   :caption: API
+   :maxdepth: 2

   modules/modules

@@ -19,3 +20,10 @@ Table of Contents
   :caption: Table of Contents

   self
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
--- a/docs/source/modules/modules.rst
+++ b/docs/source/modules/modules.rst
@@ -2,6 +2,6 @@ musicbrainzapi
 --------------

 .. toctree::
-    :maxdepth: 4
+    :maxdepth: 3

    musicbrainzapi
--- a/docs/source/modules/musicbrainzapi.api.lyrics.rst
+++ b/docs/source/modules/musicbrainzapi.api.lyrics.rst
@@ -1,7 +1,7 @@
 musicbrainzapi.api.lyrics package
 =================================

-.. autmodule:: musicbrainzapi.api.lyrics
+.. automodule:: musicbrainzapi.api.lyrics
    :members:
    :undoc-members:
    :show-inheritance:
--- a/docs/source/modules/musicbrainzapi.cli.cli.rst
+++ b/docs/source/modules/musicbrainzapi.cli.cli.rst
@@ -1,10 +0,0 @@
-.. include:: ../global.rst
-
-musicbrainzapi.cli.cli :modname:`musicbrainzapi.cli.cli`
--------------------------------------------------------------------------
-
-.. automodule:: musicbrainzapi.cli.cli
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
--- a/docs/source/modules/musicbrainzapi.cli.commands.cmd_lyrics.rst
+++ b/docs/source/modules/musicbrainzapi.cli.commands.cmd_lyrics.rst
@@ -1,16 +0,0 @@
-.. include:: ../global.rst
-
-musicbrainzapi.cli.commands.cmd_lyrics :modname:`musicbrainzapi.cli.commands.cmd_lyrics`
------------------------------------------------------------------------------------------
-
-.. automodule:: musicbrainzapi.cli.commands.cmd_lyrics
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
-
-lyrics subcommand. Use with...
-
-.. click:: musicbrainzapi.cli.cli:cli
-  :prog: musicbrainzapi
-  :show-nested:
--- a/docs/source/modules/musicbrainzapi.cli.commands.rst
+++ b/docs/source/modules/musicbrainzapi.cli.commands.rst
@@ -1,14 +0,0 @@
-.. include:: ../global.rst
-
-musicbrainzapi.cli.commands :modname:`musicbrainzapi.cli.commands`
--------------------------------------------------------------------------
-
-.. automodule:: musicbrainzapi.cli.commands
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
-
-.. toctree::
-
-   musicbrainzapi.cli.commands.cmd_lyrics
--- a/docs/source/modules/musicbrainzapi.cli.rst
+++ b/docs/source/modules/musicbrainzapi.cli.rst
@@ -1,18 +0,0 @@
-.. include:: ../global.rst
-
-musicbrainzapi.cli :modname:`musicbrainzapi.cli`
--------------------------------------------------------------------------
-
-.. automodule:: musicbrainzapi.cli
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
-
-.. toctree::
-
-   musicbrainzapi.cli.commands
-
-.. toctree::
-
-   musicbrainzapi.cli.cli
--- a/docs/source/modules/musicbrainzapi.rst
+++ b/docs/source/modules/musicbrainzapi.rst
@@ -12,6 +12,7 @@ Subpackages
 -----------

 .. toctree::
+    :maxdepth: 1

    musicbrainzapi.api
    musicbrainzapi.wordcloud
--- a/docs/source/modules/musicbrainzapi.wordcloud.resources.rst
+++ b/docs/source/modules/musicbrainzapi.wordcloud.resources.rst
@@ -1,10 +0,0 @@
-.. include:: ../global.rst
-
-musicbrainzapi.wordcloud.resources :modname:`musicbrainzapi.wordcloud.resources`
---------------------------------------------------------------------------------
-
-.. automodule:: musicbrainzapi.wordcloud.resources
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
--- a/docs/source/modules/musicbrainzapi.wordcloud.rst
+++ b/docs/source/modules/musicbrainzapi.wordcloud.rst
@@ -1,14 +1,9 @@
-.. include:: ../global.rst
-
-musicbrainzapi.wordcloud :modname:`musicbrainzapi.wordcloud`
--------------------------------------------------------------------------
+********************************
+musicbrainzapi.wordcloud package
+********************************

 .. automodule:: musicbrainzapi.wordcloud
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
-
-.. toctree::
-
-   musicbrainzapi.wordcloud.resources
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :private-members: