docs: Tweak module docs formatting

This commit is contained in:
Stein Magnus Jodal 2013-04-01 23:18:58 +02:00
parent fc33bdaedb
commit 1ac2fec4a5
11 changed files with 47 additions and 39 deletions

View File

@ -2,14 +2,14 @@
This is Mopidy's default mixer.
**Dependencies:**
**Dependencies**
- None
None
**Settings:**
**Settings**
- If this wasn't the default, you would set :attr:`mopidy.settings.MIXER`
to ``autoaudiomixer`` to use this mixer.
If this wasn't the default, you would set :attr:`mopidy.settings.MIXER` to
``autoaudiomixer`` to use this mixer.
"""
from __future__ import unicode_literals

View File

@ -1,12 +1,12 @@
"""Fake mixer for use in tests.
**Dependencies:**
**Dependencies**
- None
None
**Settings:**
**Settings**
- Set :attr:`mopidy.settings.MIXER` to ``fakemixer`` to use this mixer.
Set :attr:`mopidy.settings.MIXER` to ``fakemixer`` to use this mixer.
"""
from __future__ import unicode_literals

View File

@ -3,14 +3,14 @@
The NAD amplifier must be connected to the machine running Mopidy using a
serial cable.
**Dependencies:**
**Dependencies**
.. literalinclude:: ../../../../requirements/external_mixers.txt
**Settings:**
**Settings**
- Set :attr:`mopidy.settings.MIXER` to ``nadmixer`` to use it. You probably
also needs to add some properties to the ``MIXER`` setting.
Set :attr:`mopidy.settings.MIXER` to ``nadmixer`` to use it. You probably also
needs to add some properties to the ``MIXER`` setting.
Supported properties includes:

View File

@ -5,13 +5,13 @@ used in tests of the frontends.
The backend handles URIs starting with ``dummy:``.
**Dependencies:**
**Dependencies**
- None
None
**Settings:**
**Default config**
- None
None
"""
from __future__ import unicode_literals

View File

@ -28,15 +28,15 @@ This backend handles URIs starting with ``file:``.
See :ref:`music-from-local-storage` for further instructions on using this
backend.
**Issues:**
**Issues**
https://github.com/mopidy/mopidy/issues?labels=Local+backend
**Dependencies:**
**Dependencies**
- None
None
**Default config:**
**Default config**
.. code-block:: ini

View File

@ -49,15 +49,15 @@ See :ref:`music-from-spotify` for further instructions on using this backend.
otherwise approved in any way by Spotify. Spotify is the registered
trade mark of the Spotify Group.
**Issues:**
**Issues**
https://github.com/mopidy/mopidy/issues?labels=Spotify+backend
**Dependencies:**
**Dependencies**
.. literalinclude:: ../../../requirements/spotify.txt
**Default config:**
**Default config**
.. code-block:: ini

View File

@ -27,15 +27,15 @@ This backend will handle streaming of URIs in
:attr:`mopidy.settings.STREAM_PROTOCOLS` assuming the right plugins are
installed.
**Issues:**
**Issues**
https://github.com/mopidy/mopidy/issues?labels=Stream+backend
**Dependencies:**
**Dependencies**
- None
None
**Default config:**
**Default config**
.. code-block:: ini

View File

@ -38,11 +38,15 @@ __doc__ = """
The HTTP frontends lets you control Mopidy through HTTP and WebSockets, e.g.
from a web based client.
**Dependencies:**
**Issues**
https://github.com/mopidy/mopidy/issues?labels=HTTP+frontend
**Dependencies**
.. literalinclude:: ../../../requirements/http.txt
**Default config:**
**Default config**
.. code-block:: ini

View File

@ -26,17 +26,17 @@ Frontend which scrobbles the music you play to your `Last.fm
This frontend requires a free user account at Last.fm.
**Dependencies:**
**Dependencies**
.. literalinclude:: ../../../requirements/lastfm.txt
**Default config:**
**Default config**
.. code-block:: ini
%(config)s
**Usage:**
**Usage**
The frontend is enabled by default if all dependencies are available.
""" % {'config': formatting.indent(default_config)}

View File

@ -43,11 +43,15 @@ MPD stands for Music Player Daemon. MPD is an independent project and server.
Mopidy implements the MPD protocol, and is thus compatible with clients for the
original MPD server.
**Dependencies:**
**Issues**
- None
https://github.com/mopidy/mopidy/issues?labels=MPD+frontend
**Default config:**
**Dependencies**
None
**Default config**
.. code-block:: ini

View File

@ -23,7 +23,7 @@ interface.
An example of an MPRIS client is the `Ubuntu Sound Menu
<https://wiki.ubuntu.com/SoundMenu>`_.
**Dependencies:**
**Dependencies**
- D-Bus Python bindings. The package is named ``python-dbus`` in
Ubuntu/Debian.
@ -36,13 +36,13 @@ An example of an MPRIS client is the `Ubuntu Sound Menu
:attr:`mopidy.settings.DESKTOP_FILE`. See :ref:`install-desktop-file` for
details.
**Default config:**
**Default config**
.. code-block:: ini
%(config)s
**Usage:**
**Usage**
The frontend is enabled by default if all dependencies are available.