From 00075979616de803bf2e7e7e355a236ac2dd3e8e Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 13 Apr 2013 13:51:02 +0200 Subject: [PATCH] docs: Add mopidy.ext to API docs --- docs/api/ext.rst | 9 +++++++++ docs/api/index.rst | 1 + mopidy/ext.py | 7 +++++++ 3 files changed, 17 insertions(+) create mode 100644 docs/api/ext.rst diff --git a/docs/api/ext.rst b/docs/api/ext.rst new file mode 100644 index 00000000..594f5200 --- /dev/null +++ b/docs/api/ext.rst @@ -0,0 +1,9 @@ +.. _ext-api: + +************* +Extension API +************* + +.. automodule:: mopidy.ext + :synopsis: Extension API for extending Mopidy + :members: diff --git a/docs/api/index.rst b/docs/api/index.rst index 6ba44999..6313b7a5 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -11,4 +11,5 @@ API reference core audio frontends + ext http diff --git a/mopidy/ext.py b/mopidy/ext.py index 7fee6014..6e97844e 100644 --- a/mopidy/ext.py +++ b/mopidy/ext.py @@ -11,28 +11,35 @@ logger = logging.getLogger('mopidy.ext') class Extension(object): + """Base class for Mopidy extensions""" dist_name = None ext_name = None version = None def get_default_config(self): + """TODO""" raise NotImplementedError( 'Add at least a config section with "enabled = true"') def get_config_schema(self): + """TODO""" return config_utils.ExtensionConfigSchema() def validate_environment(self): + """TODO""" pass def get_frontend_classes(self): + """TODO""" return [] def get_backend_classes(self): + """TODO""" return [] def register_gstreamer_elements(self): + """TODO""" pass