X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Findex.rst;h=3183ce0f4f93528f21815817a1e6dd60c5b90eef;hb=refs%2Fheads%2Fmain;hp=0c204081a54a6c0fdb11b21f5025c40cb5e7ab06;hpb=cdf2dd0c1021639a4aebae4eac44fbb09a224877;p=python-musicpdaio.git diff --git a/doc/source/index.rst b/doc/source/index.rst index 0c20408..3183ce0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,19 +1,27 @@ -Welcome to musicpdaio's documentation! -====================================== +musicpdaio's documentation +========================== The documentation is structured by following the `Diátaxis`_ principles: tutorials and explanation are mainly useful to discover and learn, howtos and reference are more useful when you are familiar with musicpdaio already and you have some specific action to perform or goal to achieve. +.. note:: + + This module is still young, its API probably not stable. + .. toctree:: :maxdepth: 2 tutorial + explanations + reference + changelog + development Indices and tables ================== @@ -22,4 +30,6 @@ Indices and tables * :ref:`modindex` * :ref:`search` -.. _Diátaxis: https://diataxis.fr/ +.. meta:: + :description: musicpdaio, an asynchronous MPD (Music Player Daemon) client library written in Python. + :keywords: Sphinx, documentation, musicpdaio, python-musicpdaio, MPD, python, Music Player Daemon