From 64b5342c51a927b5fa32150d00e26968a6651af0 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Fri, 8 May 2015 00:48:31 +0200 Subject: [PATCH] docs: Document mopidy.local.translator --- docs/modules/local.rst | 14 ++++++++++++++ mopidy/local/translator.py | 3 ++- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/modules/local.rst b/docs/modules/local.rst index 014bac2a..395e8802 100644 --- a/docs/modules/local.rst +++ b/docs/modules/local.rst @@ -6,4 +6,18 @@ For details on how to use Mopidy's local backend, see :ref:`ext-local`. .. automodule:: mopidy.local :synopsis: Local backend + + +Local library API +================= + +.. autoclass:: mopidy.local.Library + :members: + + +Translation utils +================= + +.. automodule:: mopidy.local.translator + :synopsis: Translators for local library extensions :members: diff --git a/mopidy/local/translator.py b/mopidy/local/translator.py index 856e9d4c..6fc53f63 100644 --- a/mopidy/local/translator.py +++ b/mopidy/local/translator.py @@ -38,7 +38,8 @@ def path_to_file_uri(abspath): def path_to_local_track_uri(relpath): - """Convert path relative to media_dir to local track URI.""" + """Convert path relative to :confval:`local/media_dir` to local track + URI.""" if isinstance(relpath, compat.text_type): relpath = relpath.encode('utf-8') return b'local:track:%s' % urllib.quote(relpath)