]> kaliko git repositories - python-musicpdaio.git/blobdiff - doc/source/reference.rst
Fixed unused argument
[python-musicpdaio.git] / doc / source / reference.rst
index f71444ce1682f459528e5c1cce03cf6758761bd8..8bca579ce806a10920fe66079f87e005383edda7 100644 (file)
@@ -3,10 +3,12 @@
 Reference
 =========
 
+.. _environment_variables:
+
 Environment variables
 ---------------------
 
-:py:class:`mpdaio.MPDClient` honors the following environment variables:
+:py:class:`mpdaio.MPDClient<mpdaio.client.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