andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Move available settings to the main settings page

Browse Source
This commit is contained in:
Stein Magnus Jodal 2010-11-02 00:26:16 +01:00
parent dd25fadd8b
commit 8a574a94a5
2 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/api/settings.rst
View File

@ -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:

31
docs/settings.rst
View File

@ -2,13 +2,31 @@
Settings 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 ``~`` Mopidy reads settings from the file ``~/.mopidy/settings.py``, where ``~``
means your *home directory*. If your username is ``alice`` and you are running means your *home directory*. If your username is ``alice`` and you are running
Linux, the settings file should probably be at Linux, the settings file should probably be at
``/home/alice/.mopidy/settings.py``. ``/home/alice/.mopidy/settings.py``.
You can either create this file yourself, or run the ``mopidy`` command, and it You can either create the settings file yourself, or run the ``mopidy``
will create an empty settings file for you. 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 Music from Spotify
@ -88,3 +106,12 @@ file::
LASTFM_USERNAME = u'myusername' LASTFM_USERNAME = u'myusername'
LASTFM_PASSWORD = u'mysecret' LASTFM_PASSWORD = u'mysecret'
Available settings
==================
.. automodule:: mopidy.settings
:synopsis: Available settings and their default values
:members:
:undoc-members: