From 1ac2fec4a51bdf172073045d830b1285ee8961c7 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 1 Apr 2013 23:18:58 +0200 Subject: [PATCH] docs: Tweak module docs formatting --- mopidy/audio/mixers/auto.py | 10 +++++----- mopidy/audio/mixers/fake.py | 8 ++++---- mopidy/audio/mixers/nad.py | 8 ++++---- mopidy/backends/dummy.py | 8 ++++---- mopidy/backends/local/__init__.py | 8 ++++---- mopidy/backends/spotify/__init__.py | 6 +++--- mopidy/backends/stream/__init__.py | 8 ++++---- mopidy/frontends/http/__init__.py | 8 ++++++-- mopidy/frontends/lastfm/__init__.py | 6 +++--- mopidy/frontends/mpd/__init__.py | 10 +++++++--- mopidy/frontends/mpris/__init__.py | 6 +++--- 11 files changed, 47 insertions(+), 39 deletions(-) diff --git a/mopidy/audio/mixers/auto.py b/mopidy/audio/mixers/auto.py index bd61445e..96359da1 100644 --- a/mopidy/audio/mixers/auto.py +++ b/mopidy/audio/mixers/auto.py @@ -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 diff --git a/mopidy/audio/mixers/fake.py b/mopidy/audio/mixers/fake.py index 948ab82e..738491b5 100644 --- a/mopidy/audio/mixers/fake.py +++ b/mopidy/audio/mixers/fake.py @@ -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 diff --git a/mopidy/audio/mixers/nad.py b/mopidy/audio/mixers/nad.py index 52ab4757..8481de55 100644 --- a/mopidy/audio/mixers/nad.py +++ b/mopidy/audio/mixers/nad.py @@ -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: diff --git a/mopidy/backends/dummy.py b/mopidy/backends/dummy.py index c6997b12..dd021445 100644 --- a/mopidy/backends/dummy.py +++ b/mopidy/backends/dummy.py @@ -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 diff --git a/mopidy/backends/local/__init__.py b/mopidy/backends/local/__init__.py index 5499cac7..0e7b089d 100644 --- a/mopidy/backends/local/__init__.py +++ b/mopidy/backends/local/__init__.py @@ -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 diff --git a/mopidy/backends/spotify/__init__.py b/mopidy/backends/spotify/__init__.py index 409fb48d..4c3b67fe 100644 --- a/mopidy/backends/spotify/__init__.py +++ b/mopidy/backends/spotify/__init__.py @@ -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 diff --git a/mopidy/backends/stream/__init__.py b/mopidy/backends/stream/__init__.py index 31b16eea..097efc45 100644 --- a/mopidy/backends/stream/__init__.py +++ b/mopidy/backends/stream/__init__.py @@ -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 diff --git a/mopidy/frontends/http/__init__.py b/mopidy/frontends/http/__init__.py index 8c864629..6160d47c 100644 --- a/mopidy/frontends/http/__init__.py +++ b/mopidy/frontends/http/__init__.py @@ -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 diff --git a/mopidy/frontends/lastfm/__init__.py b/mopidy/frontends/lastfm/__init__.py index 7b3b2d58..f24e8f81 100644 --- a/mopidy/frontends/lastfm/__init__.py +++ b/mopidy/frontends/lastfm/__init__.py @@ -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)} diff --git a/mopidy/frontends/mpd/__init__.py b/mopidy/frontends/mpd/__init__.py index 87b21d8d..dacbf69e 100644 --- a/mopidy/frontends/mpd/__init__.py +++ b/mopidy/frontends/mpd/__init__.py @@ -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 diff --git a/mopidy/frontends/mpris/__init__.py b/mopidy/frontends/mpris/__init__.py index 28829b8f..407d4800 100644 --- a/mopidy/frontends/mpris/__init__.py +++ b/mopidy/frontends/mpris/__init__.py @@ -23,7 +23,7 @@ interface. An example of an MPRIS client is the `Ubuntu Sound Menu `_. -**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.