]> kaliko git repositories - python-musicpdaio.git/blob - doc/source/index.rst
Add Sphinx documentation
[python-musicpdaio.git] / doc / source / index.rst
1 Welcome to 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 .. toctree::
10    :maxdepth: 2
11
12    tutorial
13    explanations
14    reference
15
16
17
18 Indices and tables
19 ==================
20
21 * :ref:`genindex`
22 * :ref:`modindex`
23 * :ref:`search`
24
25 .. _Diátaxis: https://diataxis.fr/