updating documentation

2020-03-08 23:38:36 +00:00
parent f06c9f43d4
commit a322df759e
7 changed files with 20 additions and 44 deletions
--- a/docs/source/modules/musicbrainzapi.api.authenticate.rst
+++ b/docs/source/modules/musicbrainzapi.api.authenticate.rst
@@ -1,10 +0,0 @@
- .. include:: ../global.rst
-
-musicbrainzapi.api.authenticate :modname:`musicbrainzapi.api.authenticate module`
------------------------------------------------------------------------------------------
-
-.. automodule:: musicbrainzapi.api.authenticate
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
--- a/docs/source/modules/musicbrainzapi.api.lyrics.builder.rst
+++ b/docs/source/modules/musicbrainzapi.api.lyrics.builder.rst
@@ -1,10 +0,0 @@
- .. include:: ../global.rst
-
-musicbrainzapi.api.lyrics.builder :modname:`musicbrainzapi.api.lyrics.builder`
-------------------------------------------------------------------------------
-
-.. automodule:: musicbrainzapi.api.lyrics.builder
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
--- a/docs/source/modules/musicbrainzapi.api.lyrics.concrete_builder.rst
+++ b/docs/source/modules/musicbrainzapi.api.lyrics.concrete_builder.rst
@@ -1,10 +0,0 @@
-.. include:: ../global.rst
-
-musicbrainzapi.api.lyrics.concrete_builder :modname:`musicbrainzapi.api.lyrics.concrete_builder`
-------------------------------------------------------------------------------------------------
-
-.. automodule:: musicbrainzapi.api.lyrics.concrete_builder
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
--- a/docs/source/modules/musicbrainzapi.api.lyrics.director.rst
+++ b/docs/source/modules/musicbrainzapi.api.lyrics.director.rst
@@ -1,8 +0,0 @@
-musicbrainzapi.api.lyrics.director
-------------------------------------
-
-.. automodule:: musicbrainzapi.api.lyrics.director
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :private-members:
--- a/docs/source/modules/musicbrainzapi.api.lyrics.rst
+++ b/docs/source/modules/musicbrainzapi.api.lyrics.rst
@@ -8,7 +8,10 @@ musicbrainzapi.api.lyrics package
    :private-members:

 Submodules
-==========
+----------
+
+musicbrainzapi.api.lyrics.builder module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

 .. automodule:: musicbrainzapi.api.lyrics.builder
    :members:
@@ -16,12 +19,18 @@ Submodules
    :show-inheritance:
    :private-members:

+musicbrainzapi.api.lyrics.concrete_builder module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. automodule:: musicbrainzapi.api.lyrics.concrete_builder
    :members:
    :undoc-members:
    :show-inheritance:
    :private-members:

+musicbrainzapi.api.lyrics.director module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. automodule:: musicbrainzapi.api.lyrics.director
    :members:
    :undoc-members:
--- a/docs/source/modules/musicbrainzapi.api.rst
+++ b/docs/source/modules/musicbrainzapi.api.rst
@@ -8,16 +8,18 @@ musicbrainzapi.api package
    :private-members:

 Subpackages
-===========
+-----------

 .. toctree::
+    :maxdepth: 1
+
    musicbrainzapi.api.lyrics

 Submodules
-==========
+----------

-musicbrainzapi.api.authenticate
-------------------------------
+musicbrainzapi.api.authenticate module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

 .. automodule:: musicbrainzapi.api.authenticate
    :members:
--- a/docs/source/modules/musicbrainzapi.rst
+++ b/docs/source/modules/musicbrainzapi.rst
@@ -7,10 +7,13 @@ musicbrainzapi
   :show-inheritance:
   :private-members:

+
 Subpackages
-===========
+-----------

 .. toctree::
+    :maxdepth: 1
+
    musicbrainzapi.api
    musicbrainzapi.wordcloud