docs: Refresh docs wrt. mopidy.{gstreamer,outputs}

This commit is contained in:
Stein Magnus Jodal 2011-05-03 10:08:21 +02:00
parent dc018024f9
commit ed5cd8f52b
4 changed files with 23 additions and 18 deletions

View File

@ -2,19 +2,15 @@
Output API
**********
Outputs are responsible for playing audio.
Outputs are used by :mod:`mopidy.gstreamer` to output audio in some way.
.. warning::
A stable output API is not available yet, as we've only implemented a
single output module.
.. automodule:: mopidy.outputs.base
:synopsis: Base class for outputs
.. autoclass:: mopidy.outputs.BaseOutput
:members:
Output implementations
======================
* :mod:`mopidy.outputs.gstreamer`
* :class:`mopidy.outputs.LocalOutput`
* :class:`mopidy.outputs.NullOutput`
* :class:`mopidy.outputs.ShoutcastOutput`

View File

@ -0,0 +1,9 @@
********************************************
:mod:`mopidy.gstreamer` -- GStreamer adapter
********************************************
.. inheritance-diagram:: mopidy.gstreamer
.. automodule:: mopidy.gstreamer
:synopsis: GStreamer adapter
:members:

9
docs/modules/outputs.rst Normal file
View File

@ -0,0 +1,9 @@
************************************************
:mod:`mopidy.outputs` -- GStreamer audio outputs
************************************************
.. inheritance-diagram:: mopidy.outputs
.. automodule:: mopidy.outputs
:synopsis: GStreamer audio outputs
:members:

View File

@ -1,9 +0,0 @@
*********************************************************************
: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: