From 33d0739c4e663883661f8c41db00dfdadd0d195a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alban=20F=C3=A9ron?= Date: Sat, 9 Jan 2021 17:10:56 +0100 Subject: [PATCH] Moving the configuration doc --- docs/{ => setup}/configuration.rst | 18 +++++++++++------- docs/setup/database.rst | 2 +- docs/setup/index.rst | 1 + 3 files changed, 13 insertions(+), 8 deletions(-) rename docs/{ => setup}/configuration.rst (90%) diff --git a/docs/configuration.rst b/docs/setup/configuration.rst similarity index 90% rename from docs/configuration.rst rename to docs/setup/configuration.rst index 11d91db..5670ae5 100644 --- a/docs/configuration.rst +++ b/docs/setup/configuration.rst @@ -1,15 +1,19 @@ Configuration ============= -*Supysonic* looks for four files for its configuration: ``/etc/supysonic``, -``~/.supysonic``, ``~/.config/supysonic/supysonic.conf`` and ``supysonic.conf`` -in the current folder, merging values from all files. +Supysonic looks for four files for its configuration: :file:`/etc/supysonic`, +:file:`~/.supysonic`, :file:`~/.config/supysonic/supysonic.conf` and +:file:`supysonic.conf` in the current working directory, in this order, merging +values from all files. Configuration files must respect a structure similar to Windows INI file, with ``[section]`` headers and using a ``KEY = VALUE`` or ``KEY: VALUE`` syntax. -You'll find a roughly documented configuration sample file at the root of the -project, file conveniently named ``config.sample``. More details below. +If you cloned Supysonic from its `GitHub repository`__ you'll find a roughly +documented configuration sample file at the root of the project, file +conveniently named :file:`config.sample`. More details below. + +__ http://github.com/spl0k/supysonic ``[base]`` section ------------------ @@ -197,7 +201,7 @@ library folders and providing the jukebox feature. ``jukebox_command`` Command used by the jukebox mode to play a single file. - See the :doc:`jukebox documentation ` for more details. + See the :doc:`jukebox documentation <../jukebox>` for more details. ``log_file`` Rotating file where events generated by the file watcher are logged. @@ -277,7 +281,7 @@ This section defines command-line programs to be used to convert an audio file to another format or change its bitrate. All configurations in the sample below have **not** been thoroughly tested. For more details, please refer to the -:doc:`transcoding configuration `. +:doc:`transcoding configuration <../transcoding>`. .. code-block:: ini diff --git a/docs/setup/database.rst b/docs/setup/database.rst index cd089fa..71dc9e9 100644 --- a/docs/setup/database.rst +++ b/docs/setup/database.rst @@ -6,7 +6,7 @@ or PostgreSQL database. If you absolutely have no clue about databases, you can go with SQLite as it doesn't need any setup other than specifying a path for the database in the -:doc:`configuration <../configuration>`. +:doc:`configuration `. .. note:: diff --git a/docs/setup/index.rst b/docs/setup/index.rst index f347305..3abbb73 100644 --- a/docs/setup/index.rst +++ b/docs/setup/index.rst @@ -9,3 +9,4 @@ start serving your music. install database + configuration