From 819883b2b6ff92df6de38ba9d4a33c9465d4047a Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Fri, 27 Mar 2015 22:54:47 -0400 Subject: [PATCH] Add note about YAML to guide (close #1370) --- docs/conf.py | 1 - docs/guides/main.rst | 6 +++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4aeb66d33..c999763a8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,6 @@ extlinks = { } # Options for HTML output -html_theme = 'classic' htmlhelp_basename = 'beetsdoc' # Options for LaTeX output diff --git a/docs/guides/main.rst b/docs/guides/main.rst index c636dd390..9e4cd1bac 100644 --- a/docs/guides/main.rst +++ b/docs/guides/main.rst @@ -127,7 +127,9 @@ place to start:: Change that first path to a directory where you'd like to keep your music. Then, for ``library``, choose a good place to keep a database file that keeps an index -of your music. +of your music. (The config's format is `YAML`_. You'll want to configure your +text editor to use spaces, not real tabs, for indentation.) + The default configuration assumes you want to start a new organized music folder (that ``directory`` above) and that you'll *copy* cleaned-up music into that @@ -161,6 +163,8 @@ There are approximately six million other configuration options you can set here, including the directory and file naming scheme. See :doc:`/reference/config` for a full reference. +.. _YAML: http://yaml.org/ + Importing Your Library ----------------------