From 8a574a94a583add869281084a67e7dc7835f82cb Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Tue, 2 Nov 2010 00:26:16 +0100 Subject: [PATCH 1/2] docs: Move available settings to the main settings page --- docs/api/settings.rst | 27 --------------------------- docs/settings.rst | 31 +++++++++++++++++++++++++++++-- 2 files changed, 29 insertions(+), 29 deletions(-) delete mode 100644 docs/api/settings.rst diff --git a/docs/api/settings.rst b/docs/api/settings.rst deleted file mode 100644 index cfc270d6..00000000 --- a/docs/api/settings.rst +++ /dev/null @@ -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: diff --git a/docs/settings.rst b/docs/settings.rst index 41507a4a..532f52cf 100644 --- a/docs/settings.rst +++ b/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: From 5886dbb0f0788d97afd2f812672af37a24b85b14 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Tue, 2 Nov 2010 00:31:38 +0100 Subject: [PATCH 2/2] docs: Cleanup API reference headers --- docs/api/frontends.rst | 14 +++----------- docs/api/mixers.rst | 10 +++------- docs/api/models.rst | 6 +++--- docs/api/outputs.rst | 16 +++++++++------- 4 files changed, 18 insertions(+), 28 deletions(-) diff --git a/docs/api/frontends.rst b/docs/api/frontends.rst index 2f20c72a..0c1e32a3 100644 --- a/docs/api/frontends.rst +++ b/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 diff --git a/docs/api/mixers.rst b/docs/api/mixers.rst index 1d9937ac..434637f3 100644 --- a/docs/api/mixers.rst +++ b/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. diff --git a/docs/api/models.rst b/docs/api/models.rst index 62e6f75a..ef11547e 100644 --- a/docs/api/models.rst +++ b/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 diff --git a/docs/api/outputs.rst b/docs/api/outputs.rst index d8c2932e..5ef1606d 100644 --- a/docs/api/outputs.rst +++ b/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