docs: Split API and implementation docs
This commit is contained in:
parent
f50b2b15b1
commit
1437ba63de
@ -82,8 +82,8 @@ Manages the music library, e.g. searching for tracks to be added to a playlist.
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
|
|
||||||
|
|
||||||
Backends
|
Backend implementations
|
||||||
========
|
=======================
|
||||||
|
|
||||||
* :mod:`mopidy.backends.dummy`
|
* :mod:`mopidy.backends.dummy`
|
||||||
* :mod:`mopidy.backends.libspotify`
|
* :mod:`mopidy.backends.libspotify`
|
||||||
@ -27,8 +27,8 @@ Frontend API
|
|||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
|
||||||
Frontends
|
Frontend implementations
|
||||||
=========
|
========================
|
||||||
|
|
||||||
* :mod:`mopidy.frontends.lastfm`
|
* :mod:`mopidy.frontends.lastfm`
|
||||||
* :mod:`mopidy.frontends.mpd`
|
* :mod:`mopidy.frontends.mpd`
|
||||||
@ -1,6 +1,6 @@
|
|||||||
*****************
|
*************
|
||||||
API documentation
|
API reference
|
||||||
*****************
|
*************
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
|
|||||||
@ -37,61 +37,12 @@ methods as described below.
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
|
|
||||||
|
|
||||||
:mod:`mopidy.mixers.alsa` -- ALSA mixer for Linux
|
Mixer implementations
|
||||||
=================================================
|
=====================
|
||||||
|
|
||||||
.. inheritance-diagram:: mopidy.mixers.alsa
|
* :mod:`mopidy.mixers.alsa`
|
||||||
|
* :mod:`mopidy.mixers.denon`
|
||||||
.. automodule:: mopidy.mixers.alsa
|
* :mod:`mopidy.mixers.dummy`
|
||||||
:synopsis: ALSA mixer for Linux
|
* :mod:`mopidy.mixers.gstreamer_software`
|
||||||
:members:
|
* :mod:`mopidy.mixers.osa`
|
||||||
|
* :mod:`mopidy.mixers.nad`
|
||||||
|
|
||||||
:mod:`mopidy.mixers.denon` -- Hardware mixer for Denon amplifiers
|
|
||||||
=================================================================
|
|
||||||
|
|
||||||
.. inheritance-diagram:: mopidy.mixers.denon
|
|
||||||
|
|
||||||
.. automodule:: mopidy.mixers.denon
|
|
||||||
:synopsis: Hardware mixer for Denon amplifiers
|
|
||||||
:members:
|
|
||||||
|
|
||||||
|
|
||||||
:mod:`mopidy.mixers.dummy` -- Dummy mixer for testing
|
|
||||||
=====================================================
|
|
||||||
|
|
||||||
.. inheritance-diagram:: mopidy.mixers.dummy
|
|
||||||
|
|
||||||
.. automodule:: mopidy.mixers.dummy
|
|
||||||
:synopsis: Dummy mixer for testing
|
|
||||||
:members:
|
|
||||||
|
|
||||||
|
|
||||||
:mod:`mopidy.mixers.gstreamer_software` -- Software mixer for all platforms
|
|
||||||
===========================================================================
|
|
||||||
|
|
||||||
.. inheritance-diagram:: mopidy.mixers.gstreamer_software
|
|
||||||
|
|
||||||
.. automodule:: mopidy.mixers.gstreamer_software
|
|
||||||
:synopsis: Software mixer for all platforms
|
|
||||||
:members:
|
|
||||||
|
|
||||||
|
|
||||||
:mod:`mopidy.mixers.osa` -- Osa mixer for OS X
|
|
||||||
==============================================
|
|
||||||
|
|
||||||
.. inheritance-diagram:: mopidy.mixers.osa
|
|
||||||
|
|
||||||
.. automodule:: mopidy.mixers.osa
|
|
||||||
:synopsis: Osa mixer for OS X
|
|
||||||
:members:
|
|
||||||
|
|
||||||
|
|
||||||
:mod:`mopidy.mixers.nad` -- Hardware mixer for NAD amplifiers
|
|
||||||
=============================================================
|
|
||||||
|
|
||||||
.. inheritance-diagram:: mopidy.mixers.nad
|
|
||||||
|
|
||||||
.. automodule:: mopidy.mixers.nad
|
|
||||||
:synopsis: Hardware mixer for NAD amplifiers
|
|
||||||
:members:
|
|
||||||
|
|||||||
@ -12,11 +12,7 @@ A stable output API is not available yet, as we've only implemented a single
|
|||||||
output module.
|
output module.
|
||||||
|
|
||||||
|
|
||||||
:mod:`mopidy.outputs.gstreamer` -- GStreamer output for all platforms
|
Output implementations
|
||||||
=====================================================================
|
======================
|
||||||
|
|
||||||
.. inheritance-diagram:: mopidy.outputs.gstreamer
|
* :mod:`mopidy.outputs.gstreamer`
|
||||||
|
|
||||||
.. automodule:: mopidy.outputs.gstreamer
|
|
||||||
:synopsis: GStreamer output for all platforms
|
|
||||||
:members:
|
|
||||||
|
|||||||
@ -21,6 +21,7 @@ Reference documentation
|
|||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
|
|
||||||
api/index
|
api/index
|
||||||
|
modules/index
|
||||||
|
|
||||||
Development documentation
|
Development documentation
|
||||||
=========================
|
=========================
|
||||||
|
|||||||
8
docs/modules/index.rst
Normal file
8
docs/modules/index.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
****************
|
||||||
|
Module reference
|
||||||
|
****************
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
**
|
||||||
9
docs/modules/mixers/alsa.rst
Normal file
9
docs/modules/mixers/alsa.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
*************************************************
|
||||||
|
:mod:`mopidy.mixers.alsa` -- ALSA mixer for Linux
|
||||||
|
*************************************************
|
||||||
|
|
||||||
|
.. inheritance-diagram:: mopidy.mixers.alsa
|
||||||
|
|
||||||
|
.. automodule:: mopidy.mixers.alsa
|
||||||
|
:synopsis: ALSA mixer for Linux
|
||||||
|
:members:
|
||||||
9
docs/modules/mixers/denon.rst
Normal file
9
docs/modules/mixers/denon.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
*****************************************************************
|
||||||
|
:mod:`mopidy.mixers.denon` -- Hardware mixer for Denon amplifiers
|
||||||
|
*****************************************************************
|
||||||
|
|
||||||
|
.. inheritance-diagram:: mopidy.mixers.denon
|
||||||
|
|
||||||
|
.. automodule:: mopidy.mixers.denon
|
||||||
|
:synopsis: Hardware mixer for Denon amplifiers
|
||||||
|
:members:
|
||||||
9
docs/modules/mixers/dummy.rst
Normal file
9
docs/modules/mixers/dummy.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
*****************************************************
|
||||||
|
:mod:`mopidy.mixers.dummy` -- Dummy mixer for testing
|
||||||
|
*****************************************************
|
||||||
|
|
||||||
|
.. inheritance-diagram:: mopidy.mixers.dummy
|
||||||
|
|
||||||
|
.. automodule:: mopidy.mixers.dummy
|
||||||
|
:synopsis: Dummy mixer for testing
|
||||||
|
:members:
|
||||||
9
docs/modules/mixers/gstreamer_software.rst
Normal file
9
docs/modules/mixers/gstreamer_software.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
***************************************************************************
|
||||||
|
:mod:`mopidy.mixers.gstreamer_software` -- Software mixer for all platforms
|
||||||
|
***************************************************************************
|
||||||
|
|
||||||
|
.. inheritance-diagram:: mopidy.mixers.gstreamer_software
|
||||||
|
|
||||||
|
.. automodule:: mopidy.mixers.gstreamer_software
|
||||||
|
:synopsis: Software mixer for all platforms
|
||||||
|
:members:
|
||||||
9
docs/modules/mixers/nad.rst
Normal file
9
docs/modules/mixers/nad.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
*************************************************************
|
||||||
|
:mod:`mopidy.mixers.nad` -- Hardware mixer for NAD amplifiers
|
||||||
|
*************************************************************
|
||||||
|
|
||||||
|
.. inheritance-diagram:: mopidy.mixers.nad
|
||||||
|
|
||||||
|
.. automodule:: mopidy.mixers.nad
|
||||||
|
:synopsis: Hardware mixer for NAD amplifiers
|
||||||
|
:members:
|
||||||
9
docs/modules/mixers/osa.rst
Normal file
9
docs/modules/mixers/osa.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
**********************************************
|
||||||
|
:mod:`mopidy.mixers.osa` -- Osa mixer for OS X
|
||||||
|
**********************************************
|
||||||
|
|
||||||
|
.. inheritance-diagram:: mopidy.mixers.osa
|
||||||
|
|
||||||
|
.. automodule:: mopidy.mixers.osa
|
||||||
|
:synopsis: Osa mixer for OS X
|
||||||
|
:members:
|
||||||
9
docs/modules/outputs/gstreamer.rst
Normal file
9
docs/modules/outputs/gstreamer.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
*********************************************************************
|
||||||
|
:mod:`mopidy.outputs.gstreamer` -- GStreamer output for all platforms
|
||||||
|
*********************************************************************
|
||||||
|
|
||||||
|
.. inheritance-diagram:: mopidy.outputs.gstreamer
|
||||||
|
|
||||||
|
.. automodule:: mopidy.outputs.gstreamer
|
||||||
|
:synopsis: GStreamer output for all platforms
|
||||||
|
:members:
|
||||||
Loading…
Reference in New Issue
Block a user