Fix settings docs formatting

This commit is contained in:
Stein Magnus Jodal 2010-05-05 20:20:39 +02:00
parent 19593849fb
commit db97f456d4

View File

@ -30,11 +30,13 @@ CONSOLE_LOG_FORMAT = u'%(levelname)-8s %(asctime)s' + \
' [%(process)d:%(threadName)s] %(name)s\n %(message)s' ' [%(process)d:%(threadName)s] %(name)s\n %(message)s'
#: The log format used for dump logs. Default:: #: The log format used for dump logs. Default::
#: DUMP_LOG_FILENAME = CONSOLE_LOG_FORMAT #:
#: DUMP_LOG_FILENAME = CONSOLE_LOG_FORMAT
DUMP_LOG_FORMAT = CONSOLE_LOG_FORMAT DUMP_LOG_FORMAT = CONSOLE_LOG_FORMAT
#: The file to dump debug log data to. Default:: #: The file to dump debug log data to. Default::
#: DUMP_LOG_FILENAME = u'dump.log' #:
#: DUMP_LOG_FILENAME = u'dump.log'
DUMP_LOG_FILENAME = u'dump.log' DUMP_LOG_FILENAME = u'dump.log'
#: Protocol frontend to use. Default:: #: Protocol frontend to use. Default::
@ -64,28 +66,28 @@ elif sys.platform == 'darwin':
#: ALSA mixer only. What mixer control to use. If set to :class:`False`, first #: ALSA mixer only. What mixer control to use. If set to :class:`False`, first
#: ``Master`` and then ``PCM`` will be tried. #: ``Master`` and then ``PCM`` will be tried.
#: #:
#: Example: ``Master Front``. *Default:* :class:`False` #: Example: ``Master Front``. Default: :class:`False`
MIXER_ALSA_CONTROL = False MIXER_ALSA_CONTROL = False
#: External mixers only. Which port the mixer is connected to. #: External mixers only. Which port the mixer is connected to.
#: #:
#: This must point to the device port like ``/dev/ttyUSB0``. #: This must point to the device port like ``/dev/ttyUSB0``.
#: *Default:* :class:`None` #: Default: :class:`None`
MIXER_EXT_PORT = None MIXER_EXT_PORT = None
#: External mixers only. What input source the external mixer should use. #: External mixers only. What input source the external mixer should use.
#: #:
#: Example: ``Aux``. *Default:* :class:`None` #: Example: ``Aux``. Default: :class:`None`
MIXER_EXT_SOURCE = None MIXER_EXT_SOURCE = None
#: External mixers only. What state Speakers A should be in. #: External mixers only. What state Speakers A should be in.
#: #:
#: *Default:* :class:`None`. #: Default: :class:`None`.
MIXER_EXT_SPEAKERS_A = None MIXER_EXT_SPEAKERS_A = None
#: External mixers only. What state Speakers B should be in. #: External mixers only. What state Speakers B should be in.
#: #:
#: *Default:* :class:`None`. #: Default: :class:`None`.
MIXER_EXT_SPEAKERS_B = None MIXER_EXT_SPEAKERS_B = None
#: Server to use. Default:: #: Server to use. Default::
@ -96,12 +98,12 @@ SERVER = u'mopidy.mpd.server.MpdServer'
#: Which address Mopidy should bind to. Examples: #: Which address Mopidy should bind to. Examples:
#: #:
#: ``localhost`` #: ``localhost``
#: Listens only on the loopback interface. *Default.* #: Listens only on the loopback interface. Default.
#: ``0.0.0.0`` #: ``0.0.0.0``
#: Listens on all interfaces. #: Listens on all interfaces.
SERVER_HOSTNAME = u'localhost' SERVER_HOSTNAME = u'localhost'
#: Which TCP port Mopidy should listen to. *Default: 6600* #: Which TCP port Mopidy should listen to. Default: 6600
SERVER_PORT = 6600 SERVER_PORT = 6600
#: Your Spotify Premium username. Used by all Spotify backends. #: Your Spotify Premium username. Used by all Spotify backends.
@ -122,7 +124,7 @@ PLAYLIST_FOLDER = u'~/.mopidy/playlists'
#: Path to folder with local music. #: Path to folder with local music.
MUSIC_FOLDER = u'~/music' MUSIC_FOLDER = u'~/music'
#: Path to MPD tag_cache for local music #: Path to MPD tag_cache for local music.
TAG_CACHE = u'~/.mopidy/tag_cache' TAG_CACHE = u'~/.mopidy/tag_cache'
# Import user specific settings # Import user specific settings