X-Git-Url: http://git.kaliko.me/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsource%2Freference.rst;h=8bca579ce806a10920fe66079f87e005383edda7;hb=refs%2Fheads%2Fmain;hp=f71444ce1682f459528e5c1cce03cf6758761bd8;hpb=cdf2dd0c1021639a4aebae4eac44fbb09a224877;p=python-musicpdaio.git diff --git a/doc/source/reference.rst b/doc/source/reference.rst index f71444c..8bca579 100644 --- a/doc/source/reference.rst +++ b/doc/source/reference.rst @@ -3,10 +3,12 @@ Reference ========= +.. _environment_variables: + Environment variables --------------------- -:py:class:`mpdaio.MPDClient` honors the following environment variables: +:py:class:`mpdaio.MPDClient` honors the following environment variables: .. envvar:: MPD_HOST @@ -39,15 +41,31 @@ Default host: * else set host to ``localhost`` Default port: - * use :envvar:`MPD_PORT` environment variable is set + * use :envvar:`MPD_PORT` environment variable if set * else use ``6600`` Default timeout: - * use :envvar:`MPD_TIMEOUT` is set - * else use :py:obj:`mpdaio.CONNECTION_TIMEOUT` + * use :envvar:`MPD_TIMEOUT` if set + * else use :py:obj:`mpdaio.const.CONNECTION_TIMEOUT` + +Supported commands +------------------ + +.. include:: commands.rst + +Module documentation +-------------------- + +MPDClient class +^^^^^^^^^^^^^^^ + +.. automodule:: mpdaio.client + :members: +Constants +^^^^^^^^^ -Changelog ---------- +.. automodule:: mpdaio.const + :members: -No release yet +.. vim: spell spelllang=en