From c6964f93072a7c47c0064dc271cd79c6cbeb0fb1 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 13 Mar 2010 21:11:37 +0100 Subject: [PATCH] docs: Add note on what the backend API docs covers. Add graph of backend controller relations. --- docs/api/backends.rst | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/docs/api/backends.rst b/docs/api/backends.rst index 687eef31..ee53761b 100644 --- a/docs/api/backends.rst +++ b/docs/api/backends.rst @@ -1,6 +1,30 @@ -************************************* -:mod:`mopidy.backends` -- Backend API -************************************* +********************** +:mod:`mopidy.backends` +********************** + +The backend and its controllers +=============================== + +.. graph:: backend_relations + + backend -- current_playlist + backend -- library + backend -- playback + backend -- stored_playlists + + +Backend API +=========== + +.. note:: + + Currently this only documents the API that is available for use by + frontends like :class:`mopidy.mpd.handler`, and not what is required to + implement your own backend. :class:`mopidy.backends.BaseBackend` and its + controllers implements many of these methods in a matter that should be + independent of most concrete backend implementations, so you should + generally just implement or override a few of these methods yourself to + create a new backend with a complete feature set. .. automodule:: mopidy.backends :synopsis: Backend interface.