Merge branch 'develop' of http://github.com/jodal/mopidy into develop

docs/api/frontends.rst

@@ -1,6 +1,6 @@
-***********************
-:mod:`mopidy.frontends`
-***********************
+************
+Frontend API
+************
 
 A frontend may do whatever it wants to, including creating threads, opening TCP
 ports and exposing Mopidy for a type of clients.
@@ -9,14 +9,6 @@ Frontends got one main limitation: they are restricted to passing messages
 through the ``core_queue`` for all communication with the rest of Mopidy. Thus,
 the frontend API is very small and reveals little of what a frontend may do.
 
-.. automodule:: mopidy.frontends
-    :synopsis: Frontend API
-    :members:
-
-
-Frontend API
-============
-
 .. warning::
 
     A stable frontend API is not available yet, as we've only implemented a

docs/api/mixers.rst

@@ -1,6 +1,6 @@
-********************
-:mod:`mopidy.mixers`
-********************
+*********
+Mixer API
+*********
 
 Mixers are responsible for controlling volume. Clients of the mixers will
 simply instantiate a mixer and read/write to the ``volume`` attribute::
@@ -24,10 +24,6 @@ enable one of the hardware device mixers, you must the set
 :attr:`mopidy.settings.MIXER` setting to point to one of the classes found
 below, and possibly add some extra settings required by the mixer you choose.
 
-
-Mixer API
-=========
-
 All mixers should subclass :class:`mopidy.mixers.BaseMixer` and override
 methods as described below.
 

docs/api/models.rst

@@ -1,6 +1,6 @@
-********************
-:mod:`mopidy.models`
-********************
+***********
+Data models
+***********
 
 These immutable data models are used for all data transfer within the Mopidy
 backends and between the backends and the MPD frontend. All fields are optional

docs/api/outputs.rst

@@ -1,15 +1,17 @@
-*********************
-:mod:`mopidy.outputs`
-*********************
+**********
+Output API
+**********
 
 Outputs are responsible for playing audio.
 
+.. warning::
 
-Output API
-==========
+    A stable output API is not available yet, as we've only implemented a
+    single output module.
 
-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:
 
 
 Output implementations

docs/api/settings.rst

@@ -1,27 +0,0 @@
-**********************
-:mod:`mopidy.settings`
-**********************
-
-
-Changing settings
-=================
-
-For any Mopidy installation you will need to change at least a couple of
-settings. To do this, create a new file in the ``~/.mopidy/`` directory
-named ``settings.py`` and add settings you need to change from their defaults
-there.
-
-A complete ``~/.mopidy/settings.py`` may look like this::
-
-    MPD_SERVER_HOSTNAME = u'::'
-    SPOTIFY_USERNAME = u'alice'
-    SPOTIFY_PASSWORD = u'mysecret'
-
-
-Available settings
-==================
-
-.. automodule:: mopidy.settings
-    :synopsis: Available settings and their default values
-    :members:
-    :undoc-members:

docs/settings.rst

@@ -2,13 +2,31 @@
 Settings
 ********
 
+Mopidy has lots of settings. Luckily, you only need to change a few, and stay
+ignorant of the rest. Below you can find guides for typical configuration
+changes you may want to do, and a complete listing of available settings.
+
+
+Changing settings
+=================
+
 Mopidy reads settings from the file ``~/.mopidy/settings.py``, where ``~``
 means your *home directory*. If your username is ``alice`` and you are running
 Linux, the settings file should probably be at
 ``/home/alice/.mopidy/settings.py``.
 
-You can either create this file yourself, or run the ``mopidy`` command, and it
-will create an empty settings file for you.
+You can either create the settings file yourself, or run the ``mopidy``
+command, and it will create an empty settings file for you.
+
+When you have created the settings file, open it in a text editor, and add
+settings you want to change. If you want to keep the default value for setting,
+you should *not* redefine it in your own settings file.
+
+A complete ``~/.mopidy/settings.py`` may look as simple as this::
+
+    MPD_SERVER_HOSTNAME = u'::'
+    SPOTIFY_USERNAME = u'alice'
+    SPOTIFY_PASSWORD = u'mysecret'
 
 
 Music from Spotify
@@ -88,3 +106,12 @@ file::
 
     LASTFM_USERNAME = u'myusername'
     LASTFM_PASSWORD = u'mysecret'
+
+
+Available settings
+==================
+
+.. automodule:: mopidy.settings
+    :synopsis: Available settings and their default values
+    :members:
+    :undoc-members: