From 4f9f1b260fb638c98db5def568f6633d1ef4982a Mon Sep 17 00:00:00 2001 From: kaliko Date: Sun, 10 Mar 2024 15:46:14 +0100 Subject: [PATCH] Actually says "What is musicpdaio?", add forge reference --- doc/source/conf.py | 2 ++ doc/source/development.rst | 4 ++++ doc/source/explanations.rst | 9 +++++---- doc/source/index.rst | 5 +++++ doc/source/tutorial.rst | 7 ++++--- 5 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 doc/source/development.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 1aa0b41..d59ac2a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -48,7 +48,9 @@ html_theme_options = { rst_epilog = """ .. _asyncio: https://docs.python.org/3/library/asyncio.html .. _Diátaxis: https://diataxis.fr/ +.. _codeberg forge: https://codeberg.org/MusicPlayerDaemon/python-musicpdaio .. _MPD protocol documentation: http://www.musicpd.org/doc/protocol/ +.. _Music Player Daemon: http://www.musicpd.org/ .. _python-musicpd: https://kaliko.gitlab.io/python-musicpd .. _Semantic Versioning: https://semver.org/spec/v2.0.0.html .. _snake case: https://en.wikipedia.org/wiki/Snake_case diff --git a/doc/source/development.rst b/doc/source/development.rst new file mode 100644 index 0000000..a8d8c29 --- /dev/null +++ b/doc/source/development.rst @@ -0,0 +1,4 @@ +Developement +============ + +Developement is done at the `codeberg forge`_. diff --git a/doc/source/explanations.rst b/doc/source/explanations.rst index dd6965b..ecc0b9b 100644 --- a/doc/source/explanations.rst +++ b/doc/source/explanations.rst @@ -3,13 +3,14 @@ Explanations ============ -What is musicpdaio? -------------------- - | « Concurrency is about dealing with lots of things at once. » | Concurrency is not Parallelism -- Rob Pike -**musicpdaio** is the asyncio_ port of python-musicpd_. + +What is musicpdaio? +------------------- + +**musicpdaio** is an asynchronous MPD (`Music Player Daemon`_) client library written in Python. It is the asyncio_ port of python-musicpd_. The goal of this project is to keep python-musicpd_ simplicity and provide asyncio_ support. diff --git a/doc/source/index.rst b/doc/source/index.rst index a034484..3183ce0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -21,6 +21,7 @@ have some specific action to perform or goal to achieve. changelog + development Indices and tables ================== @@ -28,3 +29,7 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +.. meta:: + :description: musicpdaio, an asynchronous MPD (Music Player Daemon) client library written in Python. + :keywords: Sphinx, documentation, musicpdaio, python-musicpdaio, MPD, python, Music Player Daemon diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index 0540df9..0aee9a4 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -53,9 +53,10 @@ to connect to MPD. Cf. :ref:`reference` for more about The password is sent when a connection is made, no need to explicitly use the password command. In the following code a client is constructed with a password argument, then when the ping method is called: - * the client fetch a connection from the pool - * then a password command is sent with the password - * finally the ping command is sent. + +* the client fetch a connection from the pool +* then a password command is sent with the password +* finally the ping command is sent. .. sourcecode:: python -- 2.39.5