X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Findex.rst;h=a034484e2072f328d8c6779f6a2210671bc29871;hb=534136a439e4dbe332dcf84f528870ab71078330;hp=5b5a51bee77123d05f4b8b838f6495a83bccbc41;hpb=a1bb332d045c1c375ad2fa331476ee95d964017c;p=python-musicpdaio.git diff --git a/doc/source/index.rst b/doc/source/index.rst index 5b5a51b..a034484 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,11 +1,15 @@ -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 @@ -18,12 +22,9 @@ have some specific action to perform or goal to achieve. changelog - Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` - -.. _Diátaxis: https://diataxis.fr/