]> kaliko git repositories - python-musicpdaio.git/commitdiff
Improved documentation
authorkaliko <kaliko@azylum.org>
Sun, 10 Mar 2024 07:57:51 +0000 (08:57 +0100)
committerkaliko <kaliko@azylum.org>
Sun, 10 Mar 2024 07:57:51 +0000 (08:57 +0100)
doc/source/conf.py
doc/source/explanations.rst
doc/source/index.rst

index 94bd369b9755f4c45b4e77ecf0c64b9ec5b732b2..1aa0b4165b4c7f06dc28ba742ba5b451cbff9502 100644 (file)
@@ -42,6 +42,7 @@ html_theme_options = {
     'fixed_sidebar': 'true',
     'base_bg': '#eee',
     'pre_bg': '#fff',
+    'note_bg': '#fff',
     }
 
 rst_epilog = """
index 86c45ce2622e0b41ff7d70548cc4587f6c9eea22..dd6965bf1e38247607dfcbf211239fd4fbbcfa7b 100644 (file)
@@ -19,8 +19,8 @@ Should I use it?
 
  * If you need a plain MPD client to manage you MPD server, then stick with
    non-asyncio module python-musicpd_
- * If you're building an interactive client, concurrent access to MPD or plugin
-   into another asyncio project then use musicpdaio.
+ * If you're building an interactive client, concurrent access to MPD or need
+   to plug into another asyncio project then use musicpdaio.
 
 
 Using the client library
index 1ae27649fa1808a8055af05e18bed0820a472aaa..a034484e2072f328d8c6779f6a2210671bc29871 100644 (file)
@@ -6,6 +6,10 @@ 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