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

docs: Add note about extension's API usage

Browse Source
This commit is contained in:
Stein Magnus Jodal 2013-04-13 14:04:54 +02:00
parent 0052dbeb0d
commit a2e08c6d4e
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/index.rst
View File

@ -1,3 +1,5 @@
.. _api-ref:
************* *************
API reference API reference
************* *************

8
docs/extensiondev.rst
View File

@ -329,3 +329,11 @@ all your custom GStreamer elements.
For examples of custom GStreamer elements implemented in Python, see For examples of custom GStreamer elements implemented in Python, see
:mod:`mopidy.audio.mixers`. :mod:`mopidy.audio.mixers`.
Use of Mopidy APIs
==================
When writing an extension, you should only use APIs documented at
:ref:`api-ref`. Other parts of Mopidy, like :mod:`mopidy.utils` may change at
any time, and is not something extensions should rely on being stable.