updating latest documentation

This commit is contained in:
2020-03-09 01:15:20 +00:00
parent 3fecf9d723
commit 8fcb0d8704
11 changed files with 19 additions and 82 deletions

View File

@@ -89,6 +89,7 @@ html_theme_options = {
'collapse_navigation': True, 'collapse_navigation': True,
'display_version': True, 'display_version': True,
'prev_next_buttons_location': 'both', 'prev_next_buttons_location': 'both',
'navigation_depth': -1,
#'navigation_depth': 3, #'navigation_depth': 3,
} }

View File

@@ -12,6 +12,7 @@ Table of Contents
.. toctree:: .. toctree::
:caption: API :caption: API
:maxdepth: 2
modules/modules modules/modules
@@ -19,3 +20,10 @@ Table of Contents
:caption: Table of Contents :caption: Table of Contents
self self
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@@ -2,6 +2,6 @@ musicbrainzapi
-------------- --------------
.. toctree:: .. toctree::
:maxdepth: 4 :maxdepth: 3
musicbrainzapi musicbrainzapi

View File

@@ -1,7 +1,7 @@
musicbrainzapi.api.lyrics package musicbrainzapi.api.lyrics package
================================= =================================
.. autmodule:: musicbrainzapi.api.lyrics .. automodule:: musicbrainzapi.api.lyrics
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

View File

@@ -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:

View File

@@ -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:

View File

@@ -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

View File

@@ -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

View File

@@ -12,6 +12,7 @@ Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 1
musicbrainzapi.api musicbrainzapi.api
musicbrainzapi.wordcloud musicbrainzapi.wordcloud

View File

@@ -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:

View File

@@ -1,14 +1,9 @@
.. include:: ../global.rst ********************************
musicbrainzapi.wordcloud package
musicbrainzapi.wordcloud :modname:`musicbrainzapi.wordcloud` ********************************
--------------------------------------------------------------------------
.. automodule:: musicbrainzapi.wordcloud .. automodule:: musicbrainzapi.wordcloud
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:private-members: :private-members:
.. toctree::
musicbrainzapi.wordcloud.resources