From 0afe8ef54cc30c824594ee4d7e963b9a66d3190c Mon Sep 17 00:00:00 2001 From: Thomas Adamcik Date: Thu, 23 Apr 2015 23:40:20 +0200 Subject: [PATCH] docs: Improve core actor docs --- docs/api/core.rst | 35 ++++++++++++++++++++++++++++++++--- mopidy/core/actor.py | 18 ++++++------------ 2 files changed, 38 insertions(+), 15 deletions(-) diff --git a/docs/api/core.rst b/docs/api/core.rst index 2d1be5dc..ad7b821b 100644 --- a/docs/api/core.rst +++ b/docs/api/core.rst @@ -8,11 +8,34 @@ Core API :synopsis: Core API for use by frontends The core API is the interface that is used by frontends like -:mod:`mopidy.http` and :mod:`mopidy.mpd`. The core layer is inbetween the -frontends and the backends. +:mod:`mopidy.http` and :mod:`mopidy.mpd`. The core layer is in between the +frontends and the backends. Don't forget that you will be accessing core +as a Pykka actor. .. autoclass:: mopidy.core.Core - :members: + + .. automethod:: get_uri_schemes + + .. automethod:: get_version + + .. autoattribute:: tracklist + :annotation: + + .. autoattribute:: playback + :annotation: + + .. autoattribute:: library + :annotation: + + .. autoattribute:: playlists + :annotation: + + .. autoattribute:: mixer + :annotation: + + .. autoattribute:: history + :annotation: + Tracklist controller ==================== @@ -125,6 +148,12 @@ Core listener Deprecated API features ======================= +Core +---- + +.. autoattribute:: mopidy.core.Core.version +.. autoattribute:: mopidy.core.Core.uri_schemes + TracklistController ------------------- diff --git a/mopidy/core/actor.py b/mopidy/core/actor.py index d2454f64..c3967f6a 100644 --- a/mopidy/core/actor.py +++ b/mopidy/core/actor.py @@ -23,28 +23,22 @@ class Core( mixer.MixerListener): library = None - """The library controller. An instance of - :class:`mopidy.core.LibraryController`.""" + """An instance of :class:`~mopidy.core.LibraryController`""" history = None - """The playback history controller. An instance of - :class:`mopidy.core.HistoryController`.""" + """An instance of :class:`~mopidy.core.HistoryController`""" mixer = None - """The mixer controller. An instance of - :class:`mopidy.core.MixerController`.""" + """An instance of :class:`~mopidy.core.MixerController`""" playback = None - """The playback controller. An instance of - :class:`mopidy.core.PlaybackController`.""" + """An instance of :class:`~mopidy.core.PlaybackController`""" playlists = None - """The playlists controller. An instance of - :class:`mopidy.core.PlaylistsController`.""" + """An instance of :class:`~mopidy.core.PlaylistsController`""" tracklist = None - """The tracklist controller. An instance of - :class:`mopidy.core.TracklistController`.""" + """An instance of :class:`~mopidy.core.TracklistController`""" def __init__(self, config=None, mixer=None, backends=None, audio=None): super(Core, self).__init__()