doc/source/index.rst

   1 .. MPD_sima documentation master file, created by
   2    sphinx-quickstart on Wed Nov 11 13:21:17 2015.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 #########################
   7 MPD_sima's documentation
   8 #########################
   9
  10 MPD_sima is meant to **auto-magically queue** tracks in MPD_, it is a non interactive client for MPD_.
  11
  12 Actually there is no magic involved, it relies on music metadata found in music
  13 files tags and external information providers such as last.fm_. Then to use
  14 MPD_sima (or any advanced music players, MPD_ among them), you need to ensure
  15 your library is correctly tagged (see :ref:`metadata-convention`).
  16
  17 The default setting for MPD_sima is to queue similar artists thanks to last.fm_
  18 suggestions but there are other possibilities, see :ref:`configuration-examples`.
  19
  20 **To queue tracks from similar artists:**
  21   - start playing a track in MPD
  22   - launch MPD_sima
  23
  24 .. code-block:: sh
  25
  26     # runs against localhost MPD (or whatever is set in MPD_HOST/MPD_PORT)
  27     mpd-sima
  28
  29     # runs against a specific MPD server
  30     mpd-sima --host mpd.example.org
  31
  32
  33 #####################
  34 User's documentation
  35 #####################
  36
  37 .. toctree::
  38    :maxdepth: 2
  39    :glob:
  40
  41    user/*
  42
  43
  44 ############
  45 Unix Manuals
  46 ############
  47
  48 These manual pages were written for the Debian system (and may be used by others).
  49
  50 .. toctree::
  51    :maxdepth: 2
  52    :titlesonly:
  53
  54    man/mpd-sima.1.rst
  55    man/mpd_sima.cfg.5.rst
  56
  57
  58 ##########################
  59 Development documentation
  60 ##########################
  61
  62 .. toctree::
  63    :maxdepth: 2
  64    :titlesonly:
  65
  66    dev/mpdclient
  67    dev/meta
  68    dev/lastfm
  69    dev/cache
  70    dev/simadb
  71
  72
  73 ##################
  74 Indices and tables
  75 ##################
  76
  77 * :ref:`genindex`
  78 * :ref:`modindex`
  79 * :ref:`search`
  80
  81
  82 .. include:: links.rst
  83
  84 .. vim: spell spelllang=en