docs: Add dependencies and settings to all backends, frontends and

outputs
This commit is contained in:
Stein Magnus Jodal 2011-06-09 18:55:10 +02:00
parent 7bd281942a
commit d6b3d51d3e
6 changed files with 45 additions and 3 deletions

View File

@ -22,7 +22,11 @@ class LocalBackend(ThreadingActor, Backend):
"""
A backend for playing music from a local music archive.
**Issues:** http://github.com/mopidy/mopidy/issues/labels/backend-local
**Issues:** https://github.com/mopidy/mopidy/issues?labels=backend-local
**Dependencies:**
- None
**Settings:**

View File

@ -28,7 +28,12 @@ class SpotifyBackend(ThreadingActor, Backend):
trade mark of the Spotify Group.
**Issues:**
http://github.com/mopidy/mopidy/issues/labels/backend-spotify
https://github.com/mopidy/mopidy/issues?labels=backend-spotify
**Dependencies:**
- libspotify == 0.0.8 (libspotify8 package from apt.mopidy.com)
- pyspotify == 1.2 (python-spotify package from apt.mopidy.com)
**Settings:**

View File

@ -13,11 +13,15 @@ class MpdFrontend(ThreadingActor, BaseFrontend):
"""
The MPD frontend.
**Dependencies:**
- None
**Settings:**
- :attr:`mopidy.settings.MPD_SERVER_HOSTNAME`
- :attr:`mopidy.settings.MPD_SERVER_PASSWORD`
- :attr:`mopidy.settings.MPD_SERVER_PORT`
- :attr:`mopidy.settings.MPD_SERVER_PASSWORD`
"""
def __init__(self):

View File

@ -21,6 +21,14 @@ class CustomOutput(BaseOutput):
these cases setup :attr:`mopidy.settings.CUSTOM_OUTPUT` with a
:command:`gst-launch` compatible string describing the target setup.
**Dependencies:**
- None
**Settings:**
- :attr:`mopidy.settings.CUSTOM_OUTPUT`
"""
def describe_bin(self):
return settings.CUSTOM_OUTPUT

View File

@ -6,6 +6,14 @@ class LocalOutput(BaseOutput):
This output will normally tell GStreamer to choose whatever it thinks is
best for your system. In other words this is usually a sane choice.
**Dependencies:**
- None
**Settings:**
- None
"""
def describe_bin(self):

View File

@ -13,6 +13,19 @@ class ShoutcastOutput(BaseOutput):
supports Shoutcast. The output supports setting for: server address, port,
mount point, user, password and encoder to use. Please see
:class:`mopidy.settings` for details about settings.
**Dependencies:**
- A SHOUTcast/Icecast server
**Settings:**
- :attr:`mopidy.settings.SHOUTCAST_OUTPUT_HOSTNAME`
- :attr:`mopidy.settings.SHOUTCAST_OUTPUT_PORT`
- :attr:`mopidy.settings.SHOUTCAST_OUTPUT_USERNAME`
- :attr:`mopidy.settings.SHOUTCAST_OUTPUT_PASSWORD`
- :attr:`mopidy.settings.SHOUTCAST_OUTPUT_MOUNT`
- :attr:`mopidy.settings.SHOUTCAST_OUTPUT_ENCODER`
"""
def describe_bin(self):