andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Cleanup API reference headers

Browse Source
This commit is contained in:
Stein Magnus Jodal 2010-11-02 00:31:38 +01:00
parent 8a574a94a5
commit 5886dbb0f0
4 changed files with 18 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api/frontends.rst
View File

@ -1,6 +1,6 @@
***********************
:mod:`mopidy.frontends`
***********************
************
Frontend API
************
A frontend may do whatever it wants to, including creating threads, opening TCP
ports and exposing Mopidy for a type of clients.
@ -9,14 +9,6 @@ Frontends got one main limitation: they are restricted to passing messages
through the ``core_queue`` for all communication with the rest of Mopidy. Thus,
the frontend API is very small and reveals little of what a frontend may do.
.. automodule:: mopidy.frontends
:synopsis: Frontend API
:members:
Frontend API
============
.. warning::
A stable frontend API is not available yet, as we've only implemented a

10
docs/api/mixers.rst
View File

@ -1,6 +1,6 @@
********************
:mod:`mopidy.mixers`
********************
*********
Mixer API
*********
Mixers are responsible for controlling volume. Clients of the mixers will
simply instantiate a mixer and read/write to the ``volume`` attribute::
@ -24,10 +24,6 @@ enable one of the hardware device mixers, you must the set
:attr:`mopidy.settings.MIXER` setting to point to one of the classes found
below, and possibly add some extra settings required by the mixer you choose.
Mixer API
=========
All mixers should subclass :class:`mopidy.mixers.BaseMixer` and override
methods as described below.

6
docs/api/models.rst
View File

@ -1,6 +1,6 @@
********************
:mod:`mopidy.models`
********************
***********
Data models
***********
These immutable data models are used for all data transfer within the Mopidy
backends and between the backends and the MPD frontend. All fields are optional

16
docs/api/outputs.rst
View File

@ -1,15 +1,17 @@
*********************
:mod:`mopidy.outputs`
*********************
**********
Output API
**********
Outputs are responsible for playing audio.
.. warning::
Output API
==========
A stable output API is not available yet, as we've only implemented a
single output module.
A stable output API is not available yet, as we've only implemented a single
output module.
.. automodule:: mopidy.outputs.base
:synopsis: Base class for outputs
:members:
Output implementations