adding mkdocs

This commit is contained in:
2020-03-12 01:27:47 +00:00
parent 4e0091f80f
commit 21472e8100
25 changed files with 411 additions and 66 deletions

View File

@@ -0,0 +1,7 @@
musicbrainzapi
--------------
.. toctree::
:maxdepth: 3
musicbrainzapi

View File

@@ -0,0 +1,38 @@
musicbrainzapi.api.lyrics package
=================================
.. automodule:: musicbrainzapi.api.lyrics
:members:
:undoc-members:
:show-inheritance:
:private-members:
Submodules
----------
musicbrainzapi.api.lyrics.builder module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: musicbrainzapi.api.lyrics.builder
:members:
:undoc-members:
: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:
:show-inheritance:
:private-members:

View File

@@ -0,0 +1,28 @@
musicbrainzapi.api package
===========================
.. automodule:: musicbrainzapi.api
:members:
:undoc-members:
:show-inheritance:
:private-members:
Subpackages
-----------
.. toctree::
:maxdepth: 1
musicbrainzapi.api.lyrics
Submodules
----------
musicbrainzapi.api.authenticate module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: musicbrainzapi.api.authenticate
:members:
:undoc-members:
:show-inheritance:
:private-members:

View File

@@ -0,0 +1,19 @@
musicbrainzapi
===============
.. automodule:: musicbrainzapi
:members:
:undoc-members:
:show-inheritance:
:private-members:
Subpackages
-----------
.. toctree::
:maxdepth: 1
musicbrainzapi.api
musicbrainzapi.wordcloud

View File

@@ -0,0 +1,9 @@
********************************
musicbrainzapi.wordcloud package
********************************
.. automodule:: musicbrainzapi.wordcloud
:members:
:undoc-members:
:show-inheritance:
:private-members: