From cf1e5ff4ba82f6e386d6d506b718bf61bec042e0 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 13 Mar 2010 21:20:35 +0100 Subject: [PATCH] docs: Add section on changing settings --- docs/api/settings.rst | 25 ++++++++++++++++++++++--- mopidy/settings/default.py | 4 ++-- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/api/settings.rst b/docs/api/settings.rst index cba8b0ae..749f275d 100644 --- a/docs/api/settings.rst +++ b/docs/api/settings.rst @@ -1,6 +1,25 @@ -****************************************** -:mod:`mopidy.settings.default` -- Settings -****************************************** +********************** +: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/settings/`` directory +named ``local.py`` and add settings you need to change from their defaults +there. + +A complete ``mopidy/settings/local.py`` may look like this:: + + MPD_SERVER_HOSTNAME = u'0.0.0.0' + SPOTIFY_USERNAME = u'alice' + SPOTIFY_USERNAME = u'mysecret' + + +Available settings +================== .. automodule:: mopidy.settings.default :synopsis: Available settings and their default values. diff --git a/mopidy/settings/default.py b/mopidy/settings/default.py index 709d5c9a..7fd41fa6 100644 --- a/mopidy/settings/default.py +++ b/mopidy/settings/default.py @@ -3,8 +3,8 @@ Available settings and their default values. .. warning:: - Do *not* change settings here. Instead, add a file called - ``mopidy/settings/local.py`` and redefine settings there. + Do *not* change settings in ``mopidy/settings/default.py``. Instead, add a + file called ``mopidy/settings/local.py`` and redefine settings there. """ import sys