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

docs: Add module name to API docs headers

Browse Source 
In the same way the Python stdlib docs does.
This commit is contained in:
Stein Magnus Jodal 2015-05-07 21:02:23 +02:00
parent ad585d60d4
commit ae07603da0
10 changed files with 27 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/audio.rst
View File

@ -1,8 +1,8 @@
.. _audio-api: .. _audio-api:
********* *********************************
Audio API :mod:`mopidy.audio` --- Audio API
********* *********************************
.. module:: mopidy.audio .. module:: mopidy.audio
:synopsis: Thin wrapper around the parts of GStreamer we use :synopsis: Thin wrapper around the parts of GStreamer we use

6
docs/api/backends.rst
View File

@ -1,8 +1,8 @@
.. _backend-api: .. _backend-api:
*********** *************************************
Backend API :mod:`mopidy.backend` --- Backend API
*********** *************************************
.. module:: mopidy.backend .. module:: mopidy.backend
:synopsis: The API implemented by backends :synopsis: The API implemented by backends

6
docs/api/commands.rst
View File

@ -1,8 +1,8 @@
.. _commands-api: .. _commands-api:
************ ***************************************
Commands API :mod:`mopidy.commands` --- Commands API
************ ***************************************
.. automodule:: mopidy.commands .. automodule:: mopidy.commands
:synopsis: Commands API for Mopidy CLI. :synopsis: Commands API for Mopidy CLI.

6
docs/api/config.rst
View File

@ -1,8 +1,8 @@
.. _config-api: .. _config-api:
********** ***********************************
Config API :mod:`mopidy.config` --- Config API
********** ***********************************
.. automodule:: mopidy.config .. automodule:: mopidy.config
:synopsis: Config API for config loading and validation :synopsis: Config API for config loading and validation

6
docs/api/core.rst
View File

@ -1,8 +1,8 @@
.. _core-api: .. _core-api:
******** *******************************
Core API :mod:`mopidy.core` --- Core API
******** *******************************
.. module:: mopidy.core .. module:: mopidy.core
:synopsis: Core API for use by frontends :synopsis: Core API for use by frontends

6
docs/api/ext.rst
View File

@ -1,8 +1,8 @@
.. _ext-api: .. _ext-api:
************* **********************************
Extension API :mod:`mopidy.ext` -- Extension API
************* **********************************
If you want to learn how to make Mopidy extensions, read :ref:`extensiondev`. If you want to learn how to make Mopidy extensions, read :ref:`extensiondev`.

3
docs/api/http.rst
View File

@ -4,9 +4,6 @@
HTTP JSON-RPC API HTTP JSON-RPC API
***************** *****************
.. module:: mopidy.http
:synopsis: The HTTP frontend APIs
The :ref:`ext-http` extension makes Mopidy's :ref:`core-api` available using The :ref:`ext-http` extension makes Mopidy's :ref:`core-api` available using
JSON-RPC over HTTP using HTTP POST and WebSockets. We also provide a JavaScript JSON-RPC over HTTP using HTTP POST and WebSockets. We also provide a JavaScript
wrapper, called :ref:`Mopidy.js <mopidy-js>`, around the JSON-RPC over wrapper, called :ref:`Mopidy.js <mopidy-js>`, around the JSON-RPC over

6
docs/api/mixer.rst
View File

@ -1,8 +1,8 @@
.. _mixer-api: .. _mixer-api:
*************** ***************************************
Audio mixer API :mod:`mopidy.mixer` --- Audio mixer API
*************** ***************************************
.. module:: mopidy.mixer .. module:: mopidy.mixer
:synopsis: The audio mixer API :synopsis: The audio mixer API

6
docs/api/models.rst
View File

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

6
docs/api/zeroconf.rst
View File

@ -1,8 +1,8 @@
.. _zeroconf-api: .. _zeroconf-api:
************ ***************************************
Zeroconf API :mod:`mopidy.zeroconf` --- Zeroconf API
************ ***************************************
.. module:: mopidy.zeroconf .. module:: mopidy.zeroconf
:synopsis: Helper for publishing of services on Zeroconf :synopsis: Helper for publishing of services on Zeroconf