From ed5cd8f52b2b73d4aaacff1bf6b11ec8a0a2a61f Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Tue, 3 May 2011 10:08:21 +0200 Subject: [PATCH] docs: Refresh docs wrt. mopidy.{gstreamer,outputs} --- docs/api/outputs.rst | 14 +++++--------- docs/modules/gstreamer.rst | 9 +++++++++ docs/modules/outputs.rst | 9 +++++++++ docs/modules/outputs/gstreamer.rst | 9 --------- 4 files changed, 23 insertions(+), 18 deletions(-) create mode 100644 docs/modules/gstreamer.rst create mode 100644 docs/modules/outputs.rst delete mode 100644 docs/modules/outputs/gstreamer.rst diff --git a/docs/api/outputs.rst b/docs/api/outputs.rst index 5ef1606d..b96c909e 100644 --- a/docs/api/outputs.rst +++ b/docs/api/outputs.rst @@ -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` diff --git a/docs/modules/gstreamer.rst b/docs/modules/gstreamer.rst new file mode 100644 index 00000000..adbf5fda --- /dev/null +++ b/docs/modules/gstreamer.rst @@ -0,0 +1,9 @@ +******************************************** +:mod:`mopidy.gstreamer` -- GStreamer adapter +******************************************** + +.. inheritance-diagram:: mopidy.gstreamer + +.. automodule:: mopidy.gstreamer + :synopsis: GStreamer adapter + :members: diff --git a/docs/modules/outputs.rst b/docs/modules/outputs.rst new file mode 100644 index 00000000..0a6986dd --- /dev/null +++ b/docs/modules/outputs.rst @@ -0,0 +1,9 @@ +************************************************ +:mod:`mopidy.outputs` -- GStreamer audio outputs +************************************************ + +.. inheritance-diagram:: mopidy.outputs + +.. automodule:: mopidy.outputs + :synopsis: GStreamer audio outputs + :members: diff --git a/docs/modules/outputs/gstreamer.rst b/docs/modules/outputs/gstreamer.rst deleted file mode 100644 index 69c77dad..00000000 --- a/docs/modules/outputs/gstreamer.rst +++ /dev/null @@ -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: