From d6b3d51d3e88ace641f1d9935713918c42c11a07 Mon Sep 17 00:00:00 2001
From: Stein Magnus Jodal <stein.magnus@jodal.no>
Date: Thu, 9 Jun 2011 18:55:10 +0200
Subject: [PATCH] docs: Add dependencies and settings to all backends,
 frontends and outputs

---
 mopidy/backends/local/__init__.py   |  6 +++++-
 mopidy/backends/spotify/__init__.py |  7 ++++++-
 mopidy/frontends/mpd/__init__.py    |  6 +++++-
 mopidy/outputs/custom.py            |  8 ++++++++
 mopidy/outputs/local.py             |  8 ++++++++
 mopidy/outputs/shoutcast.py         | 13 +++++++++++++
 6 files changed, 45 insertions(+), 3 deletions(-)

diff --git a/mopidy/backends/local/__init__.py b/mopidy/backends/local/__init__.py
index 5da80a18..93cf3534 100644
--- a/mopidy/backends/local/__init__.py
+++ b/mopidy/backends/local/__init__.py
@@ -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:**
 
diff --git a/mopidy/backends/spotify/__init__.py b/mopidy/backends/spotify/__init__.py
index da839b26..87997059 100644
--- a/mopidy/backends/spotify/__init__.py
+++ b/mopidy/backends/spotify/__init__.py
@@ -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:**
 
diff --git a/mopidy/frontends/mpd/__init__.py b/mopidy/frontends/mpd/__init__.py
index 24c21c38..175aa0ee 100644
--- a/mopidy/frontends/mpd/__init__.py
+++ b/mopidy/frontends/mpd/__init__.py
@@ -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):
diff --git a/mopidy/outputs/custom.py b/mopidy/outputs/custom.py
index c5ca30bb..09239a44 100644
--- a/mopidy/outputs/custom.py
+++ b/mopidy/outputs/custom.py
@@ -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
diff --git a/mopidy/outputs/local.py b/mopidy/outputs/local.py
index e004a076..8101e026 100644
--- a/mopidy/outputs/local.py
+++ b/mopidy/outputs/local.py
@@ -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):
diff --git a/mopidy/outputs/shoutcast.py b/mopidy/outputs/shoutcast.py
index d2605514..ffe09aae 100644
--- a/mopidy/outputs/shoutcast.py
+++ b/mopidy/outputs/shoutcast.py
@@ -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):