From 397fdf90d25a51b324102befd18c55d16cffefb3 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 13 Mar 2010 18:23:23 +0100 Subject: [PATCH] docs: Add inheritance diagrams to mixers --- docs/api/mixers.rst | 10 ++++++++++ docs/conf.py | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/api/mixers.rst b/docs/api/mixers.rst index 7cf5a822..0d0da1d4 100644 --- a/docs/api/mixers.rst +++ b/docs/api/mixers.rst @@ -24,6 +24,8 @@ in the settings, Mopidy will choose one for you based upon what OS you run. See :synopsis: ALSA mixer :members: +.. inheritance-diagram:: mopidy.mixers.alsa.AlsaMixer + :mod:`mopidy.mixers.dummy` -- Dummy mixer ----------------------------------------- @@ -32,6 +34,8 @@ in the settings, Mopidy will choose one for you based upon what OS you run. See :synopsis: Dummy mixer :members: +.. inheritance-diagram:: mopidy.mixers.dummy + :mod:`mopidy.mixers.osa` -- Osa mixer ------------------------------------- @@ -40,6 +44,8 @@ in the settings, Mopidy will choose one for you based upon what OS you run. See :synopsis: Osa mixer :members: +.. inheritance-diagram:: mopidy.mixers.osa + External device mixers ====================== @@ -58,6 +64,8 @@ required by the mixer you choose. :synopsis: Denon amplifier mixer :members: +.. inheritance-diagram:: mopidy.mixers.denon + :mod:`mopidy.mixers.nad` -- NAD amplifier mixer ----------------------------------------------- @@ -65,3 +73,5 @@ required by the mixer you choose. .. automodule:: mopidy.mixers.nad :synopsis: NAD amplifier mixer :members: + +.. inheritance-diagram:: mopidy.mixers.nad diff --git a/docs/conf.py b/docs/conf.py index 1f4cc3a2..3b00883e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,7 +26,7 @@ import mopidy # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'autodoc_private_members', - 'sphinx.ext.graphviz'] + 'sphinx.ext.graphviz', 'sphinx.ext.inheritance_diagram'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']