From 534136a439e4dbe332dcf84f528870ab71078330 Mon Sep 17 00:00:00 2001 From: kaliko Date: Sun, 10 Mar 2024 08:57:51 +0100 Subject: [PATCH] Improved documentation --- doc/source/conf.py | 1 + doc/source/explanations.rst | 4 ++-- doc/source/index.rst | 4 ++++ 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 94bd369..1aa0b41 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -42,6 +42,7 @@ html_theme_options = { 'fixed_sidebar': 'true', 'base_bg': '#eee', 'pre_bg': '#fff', + 'note_bg': '#fff', } rst_epilog = """ diff --git a/doc/source/explanations.rst b/doc/source/explanations.rst index 86c45ce..dd6965b 100644 --- a/doc/source/explanations.rst +++ b/doc/source/explanations.rst @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 1ae2764..a034484 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 -- 2.39.2