From 307a879a901e801a48daf97f071b072b4adcff3e Mon Sep 17 00:00:00 2001 From: tom roth Date: Fri, 3 Jul 2015 13:34:26 +0200 Subject: [PATCH] file-browser: added some documentation --- docs/ext/backends.rst | 4 ++++ docs/ext/files.rst | 48 +++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 53 insertions(+) create mode 100644 docs/ext/files.rst diff --git a/docs/ext/backends.rst b/docs/ext/backends.rst index 1ab00005..19f59806 100644 --- a/docs/ext/backends.rst +++ b/docs/ext/backends.rst @@ -65,6 +65,10 @@ https://github.com/tkem/mopidy-dleyna Provides a backend for playing music from Digital Media Servers using the `dLeyna `_ D-Bus interface. +Mopidy-Files +============ + +Bundled with Mopidy. See :ref:`ext-files`. Mopidy-Grooveshark ================== diff --git a/docs/ext/files.rst b/docs/ext/files.rst new file mode 100644 index 00000000..a4508689 --- /dev/null +++ b/docs/ext/files.rst @@ -0,0 +1,48 @@ +.. _ext-files: + +************ +Mopidy-Files +************ + +Mopidy-Files is an extension for playing music from your local music archive. +It is bundled with Mopidy and enabled by default. +It allows you to browse through your local file system. +Only files that are considered playable will be shown + +This backend handles URIs starting with ``file:``. + + +Configuration +============= + +See :ref:`config` for general help on configuring Mopidy. + +.. literalinclude:: ../../mopidy/files/ext.conf + :language: ini + +.. confval:: files/enabled + + If the files extension should be enabled or not. + +.. confval:: files/media_dir + + A list of directories to be browsable. + Each Directory path has to be written in a separate line. + Optionally the path can be followed by : and a name that will be shown for that path. + +.. confval:: files/show_hidden + + Whether to show hidden files and directories that start with a dot. + Default is false. + +.. confval:: files/follow_symlinks + + Whether to follow symbolic links found in :confval:`files/media_dir`. + Directories and files that are outside the configured media_dirs will not be shown. + Default is false + +.. confval:: files/metadata_timeout + + Number of milliseconds before giving up scanning a file and moving on to + the next file. Reducing the value might speed up the directory listing, + but can lead to some tracks not being shown. diff --git a/docs/index.rst b/docs/index.rst index 3a2998d5..8d621d26 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -96,6 +96,7 @@ Extensions :maxdepth: 2 ext/local + ext/files ext/m3u ext/stream ext/http