Add Sphinx documentation

[python-musicpdaio.git] / doc / source / index.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644 (file)
index 0000000..0c20408
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,25 @@
+Welcome to 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.
+
+.. toctree::
+   :maxdepth: 2
+
+   tutorial
+   explanations
+   reference
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. _Diátaxis: https://diataxis.fr/