docs: Move MpdHandler docs into API docs

This commit is contained in:
Stein Magnus Jodal 2010-02-22 20:26:35 +01:00
parent daab3e216a
commit 1b231c671e
3 changed files with 13 additions and 18 deletions

View File

@ -12,8 +12,7 @@ API documentation
.. toctree::
:glob:
api/*
api/**
Scope
=====
@ -96,22 +95,6 @@ Then, to generate docs::
make html # To generate HTML docs
Music Player Daemon (MPD)
=========================
The `MPD protocol documentation <http://www.musicpd.org/doc/protocol/>`_ is a
useful resource. It is rather incomplete with regards to data formats, both for
requests and responses. Thus we have to talk a great deal with the the original
`MPD server <http://mpd.wikia.com/>`_ using telnet to get the details we need
to implement our own MPD server which is compatible with the numerous existing
`MPD clients <http://mpd.wikia.com/wiki/Clients>`_.
.. toctree::
:glob:
mpd/*
spytify
=======

View File

@ -1,3 +1,15 @@
"""
Our MPD protocol implementation
This is partly based upon the `MPD protocol documentation
<http://www.musicpd.org/doc/protocol/>`_, which is a useful resource, but it is
rather incomplete with regards to data formats, both for requests and
responses. Thus, we have had to talk a great deal with the the original `MPD
server <http://mpd.wikia.com/>`_ using telnet to get the details we need to
implement our own MPD server which is compatible with the numerous existing
`MPD clients <http://mpd.wikia.com/wiki/Clients>`_.
"""
import logging
import re
import sys