doc/source/index.rst

   1 musicpdaio's documentation
   2 ==========================
   3
   4 The documentation is structured by following the `Diátaxis`_ principles:
   5 tutorials and explanation are mainly useful to discover and learn, howtos and
   6 reference are more useful when you are familiar with musicpdaio already and you
   7 have some specific action to perform or goal to achieve.
   8
   9 .. note::
  10
  11    This module is still young, its API probably not stable.
  12
  13 .. toctree::
  14    :maxdepth: 2
  15
  16    tutorial
  17
  18    explanations
  19
  20    reference
  21
  22    changelog
  23
  24    development
  25
  26 Indices and tables
  27 ==================
  28
  29 * :ref:`genindex`
  30 * :ref:`modindex`
  31 * :ref:`search`
  32
  33 .. meta::
  34    :description: musicpdaio, an asynchronous MPD (Music Player Daemon) client library written in Python.
  35    :keywords: Sphinx, documentation, musicpdaio, python-musicpdaio, MPD, python, Music Player Daemon