diff --git a/docs/source/conf.py b/docs/source/conf.py index 801b4a1..06e73fa 100644 --- 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, } diff --git a/docs/source/index.rst b/docs/source/index.rst index a41a5ec..566e559 100644 --- 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` diff --git a/docs/source/modules/modules.rst b/docs/source/modules/modules.rst index 7c27e42..4c2e61f 100644 --- a/docs/source/modules/modules.rst +++ b/docs/source/modules/modules.rst @@ -2,6 +2,6 @@ musicbrainzapi -------------- .. toctree:: - :maxdepth: 4 + :maxdepth: 3 musicbrainzapi diff --git a/docs/source/modules/musicbrainzapi.api.lyrics.rst b/docs/source/modules/musicbrainzapi.api.lyrics.rst index 4ba0104..1c1f4ad 100644 --- 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: diff --git a/docs/source/modules/musicbrainzapi.cli.cli.rst b/docs/source/modules/musicbrainzapi.cli.cli.rst deleted file mode 100644 index 9b6e813..0000000 --- a/docs/source/modules/musicbrainzapi.cli.cli.rst +++ /dev/null @@ -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: diff --git a/docs/source/modules/musicbrainzapi.cli.commands.cmd_lyrics.rst b/docs/source/modules/musicbrainzapi.cli.commands.cmd_lyrics.rst deleted file mode 100644 index 86946a1..0000000 --- a/docs/source/modules/musicbrainzapi.cli.commands.cmd_lyrics.rst +++ /dev/null @@ -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: diff --git a/docs/source/modules/musicbrainzapi.cli.commands.rst b/docs/source/modules/musicbrainzapi.cli.commands.rst deleted file mode 100644 index 5dce26c..0000000 --- a/docs/source/modules/musicbrainzapi.cli.commands.rst +++ /dev/null @@ -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 diff --git a/docs/source/modules/musicbrainzapi.cli.rst b/docs/source/modules/musicbrainzapi.cli.rst deleted file mode 100644 index c3f2276..0000000 --- a/docs/source/modules/musicbrainzapi.cli.rst +++ /dev/null @@ -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 diff --git a/docs/source/modules/musicbrainzapi.rst b/docs/source/modules/musicbrainzapi.rst index 09b9363..109766f 100644 --- a/docs/source/modules/musicbrainzapi.rst +++ b/docs/source/modules/musicbrainzapi.rst @@ -12,6 +12,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 1 musicbrainzapi.api musicbrainzapi.wordcloud diff --git a/docs/source/modules/musicbrainzapi.wordcloud.resources.rst b/docs/source/modules/musicbrainzapi.wordcloud.resources.rst deleted file mode 100644 index 8a64ee0..0000000 --- a/docs/source/modules/musicbrainzapi.wordcloud.resources.rst +++ /dev/null @@ -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: diff --git a/docs/source/modules/musicbrainzapi.wordcloud.rst b/docs/source/modules/musicbrainzapi.wordcloud.rst index 9c42b3d..00d077a 100644 --- 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: