From 1b20c75d77944358ef91f7b8db9d2fbb66d87dfc Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 31 Oct 2010 02:16:06 +0200 Subject: [PATCH] docs: Split backend docs into multiple files --- docs/api/backends/dummy.rst | 7 +++++ docs/api/{backends.rst => backends/index.rst} | 26 ++++--------------- docs/api/backends/libspotify.rst | 7 +++++ docs/api/backends/local.rst | 7 +++++ docs/api/frontends/index.rst | 4 +++ 5 files changed, 30 insertions(+), 21 deletions(-) create mode 100644 docs/api/backends/dummy.rst rename docs/api/{backends.rst => backends/index.rst} (74%) create mode 100644 docs/api/backends/libspotify.rst create mode 100644 docs/api/backends/local.rst diff --git a/docs/api/backends/dummy.rst b/docs/api/backends/dummy.rst new file mode 100644 index 00000000..03b2e6ce --- /dev/null +++ b/docs/api/backends/dummy.rst @@ -0,0 +1,7 @@ +********************************************************* +:mod:`mopidy.backends.dummy` -- Dummy backend for testing +********************************************************* + +.. automodule:: mopidy.backends.dummy + :synopsis: Dummy backend used for testing + :members: diff --git a/docs/api/backends.rst b/docs/api/backends/index.rst similarity index 74% rename from docs/api/backends.rst rename to docs/api/backends/index.rst index f675541a..100f6f0d 100644 --- a/docs/api/backends.rst +++ b/docs/api/backends/index.rst @@ -82,25 +82,9 @@ Manages the music library, e.g. searching for tracks to be added to a playlist. :undoc-members: -:mod:`mopidy.backends.dummy` -- Dummy backend for testing -========================================================= +Backends +======== -.. automodule:: mopidy.backends.dummy - :synopsis: Dummy backend used for testing - :members: - - -:mod:`mopidy.backends.libspotify` -- Libspotify backend -======================================================= - -.. automodule:: mopidy.backends.libspotify - :synopsis: Spotify backend using the libspotify library - :members: - - -:mod:`mopidy.backends.local` -- Local backend -===================================================== - -.. automodule:: mopidy.backends.local - :synopsis: Backend for playing music files on local storage - :members: +* :mod:`mopidy.backends.dummy` +* :mod:`mopidy.backends.libspotify` +* :mod:`mopidy.backends.local` diff --git a/docs/api/backends/libspotify.rst b/docs/api/backends/libspotify.rst new file mode 100644 index 00000000..e7528757 --- /dev/null +++ b/docs/api/backends/libspotify.rst @@ -0,0 +1,7 @@ +******************************************************* +:mod:`mopidy.backends.libspotify` -- Libspotify backend +******************************************************* + +.. automodule:: mopidy.backends.libspotify + :synopsis: Spotify backend using the libspotify library + :members: diff --git a/docs/api/backends/local.rst b/docs/api/backends/local.rst new file mode 100644 index 00000000..892f5a87 --- /dev/null +++ b/docs/api/backends/local.rst @@ -0,0 +1,7 @@ +********************************************* +:mod:`mopidy.backends.local` -- Local backend +********************************************* + +.. automodule:: mopidy.backends.local + :synopsis: Backend for playing music files on local storage + :members: diff --git a/docs/api/frontends/index.rst b/docs/api/frontends/index.rst index 05595418..2ab1df8b 100644 --- a/docs/api/frontends/index.rst +++ b/docs/api/frontends/index.rst @@ -4,6 +4,10 @@ A frontend is responsible for exposing Mopidy for a type of clients. +.. automodule:: mopidy.frontends + :synopsis: Frontend API + :members: + Frontend API ============