andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api/outputs.rst
View File

@ -2,19 +2,15 @@
Output API Output API
********** **********
Outputs are responsible for playing audio. Outputs are used by :mod:`mopidy.gstreamer` to output audio in some way.
.. warning:: .. autoclass:: mopidy.outputs.BaseOutput
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
:members: :members:
Output implementations Output implementations
====================== ======================
* :mod:`mopidy.outputs.gstreamer` * :class:`mopidy.outputs.LocalOutput`
* :class:`mopidy.outputs.NullOutput`
* :class:`mopidy.outputs.ShoutcastOutput`

9
docs/modules/gstreamer.rst Normal file
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:

9
docs/modules/outputs/gstreamer.rst
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: