From 1437ba63ded573d6ddbeeaf468fe76c5ec7e8f7a Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 31 Oct 2010 02:16:40 +0100 Subject: [PATCH] docs: Split API and implementation docs --- docs/api/{backends/index.rst => backends.rst} | 4 +- .../{frontends/index.rst => frontends.rst} | 4 +- docs/api/index.rst | 6 +- docs/api/mixers.rst | 65 +++---------------- docs/api/outputs.rst | 10 +-- docs/index.rst | 1 + docs/{api => modules}/backends/dummy.rst | 0 docs/{api => modules}/backends/libspotify.rst | 0 docs/{api => modules}/backends/local.rst | 0 docs/{api => modules}/frontends/lastfm.rst | 0 docs/{api => modules}/frontends/mpd.rst | 0 docs/modules/index.rst | 8 +++ docs/modules/mixers/alsa.rst | 9 +++ docs/modules/mixers/denon.rst | 9 +++ docs/modules/mixers/dummy.rst | 9 +++ docs/modules/mixers/gstreamer_software.rst | 9 +++ docs/modules/mixers/nad.rst | 9 +++ docs/modules/mixers/osa.rst | 9 +++ docs/modules/outputs/gstreamer.rst | 9 +++ 19 files changed, 90 insertions(+), 71 deletions(-) rename docs/api/{backends/index.rst => backends.rst} (97%) rename docs/api/{frontends/index.rst => frontends.rst} (94%) rename docs/{api => modules}/backends/dummy.rst (100%) rename docs/{api => modules}/backends/libspotify.rst (100%) rename docs/{api => modules}/backends/local.rst (100%) rename docs/{api => modules}/frontends/lastfm.rst (100%) rename docs/{api => modules}/frontends/mpd.rst (100%) create mode 100644 docs/modules/index.rst create mode 100644 docs/modules/mixers/alsa.rst create mode 100644 docs/modules/mixers/denon.rst create mode 100644 docs/modules/mixers/dummy.rst create mode 100644 docs/modules/mixers/gstreamer_software.rst create mode 100644 docs/modules/mixers/nad.rst create mode 100644 docs/modules/mixers/osa.rst create mode 100644 docs/modules/outputs/gstreamer.rst diff --git a/docs/api/backends/index.rst b/docs/api/backends.rst similarity index 97% rename from docs/api/backends/index.rst rename to docs/api/backends.rst index 100f6f0d..c8a72b4d 100644 --- a/docs/api/backends/index.rst +++ b/docs/api/backends.rst @@ -82,8 +82,8 @@ Manages the music library, e.g. searching for tracks to be added to a playlist. :undoc-members: -Backends -======== +Backend implementations +======================= * :mod:`mopidy.backends.dummy` * :mod:`mopidy.backends.libspotify` diff --git a/docs/api/frontends/index.rst b/docs/api/frontends.rst similarity index 94% rename from docs/api/frontends/index.rst rename to docs/api/frontends.rst index b01bac3d..2f20c72a 100644 --- a/docs/api/frontends/index.rst +++ b/docs/api/frontends.rst @@ -27,8 +27,8 @@ Frontend API :members: -Frontends -========= +Frontend implementations +======================== * :mod:`mopidy.frontends.lastfm` * :mod:`mopidy.frontends.mpd` diff --git a/docs/api/index.rst b/docs/api/index.rst index 86f4e06e..87ec9bb3 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,6 +1,6 @@ -***************** -API documentation -***************** +************* +API reference +************* .. toctree:: :glob: diff --git a/docs/api/mixers.rst b/docs/api/mixers.rst index edaea306..1d9937ac 100644 --- a/docs/api/mixers.rst +++ b/docs/api/mixers.rst @@ -37,61 +37,12 @@ methods as described below. :undoc-members: -:mod:`mopidy.mixers.alsa` -- ALSA mixer for Linux -================================================= +Mixer implementations +===================== -.. inheritance-diagram:: mopidy.mixers.alsa - -.. automodule:: mopidy.mixers.alsa - :synopsis: ALSA mixer for Linux - :members: - - -:mod:`mopidy.mixers.denon` -- Hardware mixer for Denon amplifiers -================================================================= - -.. inheritance-diagram:: mopidy.mixers.denon - -.. automodule:: mopidy.mixers.denon - :synopsis: Hardware mixer for Denon amplifiers - :members: - - -:mod:`mopidy.mixers.dummy` -- Dummy mixer for testing -===================================================== - -.. inheritance-diagram:: mopidy.mixers.dummy - -.. automodule:: mopidy.mixers.dummy - :synopsis: Dummy mixer for testing - :members: - - -:mod:`mopidy.mixers.gstreamer_software` -- Software mixer for all platforms -=========================================================================== - -.. inheritance-diagram:: mopidy.mixers.gstreamer_software - -.. automodule:: mopidy.mixers.gstreamer_software - :synopsis: Software mixer for all platforms - :members: - - -:mod:`mopidy.mixers.osa` -- Osa mixer for OS X -============================================== - -.. inheritance-diagram:: mopidy.mixers.osa - -.. automodule:: mopidy.mixers.osa - :synopsis: Osa mixer for OS X - :members: - - -:mod:`mopidy.mixers.nad` -- Hardware mixer for NAD amplifiers -============================================================= - -.. inheritance-diagram:: mopidy.mixers.nad - -.. automodule:: mopidy.mixers.nad - :synopsis: Hardware mixer for NAD amplifiers - :members: +* :mod:`mopidy.mixers.alsa` +* :mod:`mopidy.mixers.denon` +* :mod:`mopidy.mixers.dummy` +* :mod:`mopidy.mixers.gstreamer_software` +* :mod:`mopidy.mixers.osa` +* :mod:`mopidy.mixers.nad` diff --git a/docs/api/outputs.rst b/docs/api/outputs.rst index 8f4e33c0..d8c2932e 100644 --- a/docs/api/outputs.rst +++ b/docs/api/outputs.rst @@ -12,11 +12,7 @@ A stable output API is not available yet, as we've only implemented a single output module. -:mod:`mopidy.outputs.gstreamer` -- GStreamer output for all platforms -===================================================================== +Output implementations +====================== -.. inheritance-diagram:: mopidy.outputs.gstreamer - -.. automodule:: mopidy.outputs.gstreamer - :synopsis: GStreamer output for all platforms - :members: +* :mod:`mopidy.outputs.gstreamer` diff --git a/docs/index.rst b/docs/index.rst index f53373dc..09029a4f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,7 @@ Reference documentation :maxdepth: 3 api/index + modules/index Development documentation ========================= diff --git a/docs/api/backends/dummy.rst b/docs/modules/backends/dummy.rst similarity index 100% rename from docs/api/backends/dummy.rst rename to docs/modules/backends/dummy.rst diff --git a/docs/api/backends/libspotify.rst b/docs/modules/backends/libspotify.rst similarity index 100% rename from docs/api/backends/libspotify.rst rename to docs/modules/backends/libspotify.rst diff --git a/docs/api/backends/local.rst b/docs/modules/backends/local.rst similarity index 100% rename from docs/api/backends/local.rst rename to docs/modules/backends/local.rst diff --git a/docs/api/frontends/lastfm.rst b/docs/modules/frontends/lastfm.rst similarity index 100% rename from docs/api/frontends/lastfm.rst rename to docs/modules/frontends/lastfm.rst diff --git a/docs/api/frontends/mpd.rst b/docs/modules/frontends/mpd.rst similarity index 100% rename from docs/api/frontends/mpd.rst rename to docs/modules/frontends/mpd.rst diff --git a/docs/modules/index.rst b/docs/modules/index.rst new file mode 100644 index 00000000..44da0028 --- /dev/null +++ b/docs/modules/index.rst @@ -0,0 +1,8 @@ +**************** +Module reference +**************** + +.. toctree:: + :glob: + + ** diff --git a/docs/modules/mixers/alsa.rst b/docs/modules/mixers/alsa.rst new file mode 100644 index 00000000..05f429eb --- /dev/null +++ b/docs/modules/mixers/alsa.rst @@ -0,0 +1,9 @@ +************************************************* +:mod:`mopidy.mixers.alsa` -- ALSA mixer for Linux +************************************************* + +.. inheritance-diagram:: mopidy.mixers.alsa + +.. automodule:: mopidy.mixers.alsa + :synopsis: ALSA mixer for Linux + :members: diff --git a/docs/modules/mixers/denon.rst b/docs/modules/mixers/denon.rst new file mode 100644 index 00000000..ac944ccc --- /dev/null +++ b/docs/modules/mixers/denon.rst @@ -0,0 +1,9 @@ +***************************************************************** +:mod:`mopidy.mixers.denon` -- Hardware mixer for Denon amplifiers +***************************************************************** + +.. inheritance-diagram:: mopidy.mixers.denon + +.. automodule:: mopidy.mixers.denon + :synopsis: Hardware mixer for Denon amplifiers + :members: diff --git a/docs/modules/mixers/dummy.rst b/docs/modules/mixers/dummy.rst new file mode 100644 index 00000000..6665f949 --- /dev/null +++ b/docs/modules/mixers/dummy.rst @@ -0,0 +1,9 @@ +***************************************************** +:mod:`mopidy.mixers.dummy` -- Dummy mixer for testing +***************************************************** + +.. inheritance-diagram:: mopidy.mixers.dummy + +.. automodule:: mopidy.mixers.dummy + :synopsis: Dummy mixer for testing + :members: diff --git a/docs/modules/mixers/gstreamer_software.rst b/docs/modules/mixers/gstreamer_software.rst new file mode 100644 index 00000000..ef8cc310 --- /dev/null +++ b/docs/modules/mixers/gstreamer_software.rst @@ -0,0 +1,9 @@ +*************************************************************************** +:mod:`mopidy.mixers.gstreamer_software` -- Software mixer for all platforms +*************************************************************************** + +.. inheritance-diagram:: mopidy.mixers.gstreamer_software + +.. automodule:: mopidy.mixers.gstreamer_software + :synopsis: Software mixer for all platforms + :members: diff --git a/docs/modules/mixers/nad.rst b/docs/modules/mixers/nad.rst new file mode 100644 index 00000000..d441b3fd --- /dev/null +++ b/docs/modules/mixers/nad.rst @@ -0,0 +1,9 @@ +************************************************************* +:mod:`mopidy.mixers.nad` -- Hardware mixer for NAD amplifiers +************************************************************* + +.. inheritance-diagram:: mopidy.mixers.nad + +.. automodule:: mopidy.mixers.nad + :synopsis: Hardware mixer for NAD amplifiers + :members: diff --git a/docs/modules/mixers/osa.rst b/docs/modules/mixers/osa.rst new file mode 100644 index 00000000..14bf9a49 --- /dev/null +++ b/docs/modules/mixers/osa.rst @@ -0,0 +1,9 @@ +********************************************** +:mod:`mopidy.mixers.osa` -- Osa mixer for OS X +********************************************** + +.. inheritance-diagram:: mopidy.mixers.osa + +.. automodule:: mopidy.mixers.osa + :synopsis: Osa mixer for OS X + :members: diff --git a/docs/modules/outputs/gstreamer.rst b/docs/modules/outputs/gstreamer.rst new file mode 100644 index 00000000..69c77dad --- /dev/null +++ b/docs/modules/outputs/gstreamer.rst @@ -0,0 +1,9 @@ +********************************************************************* +:mod:`mopidy.outputs.gstreamer` -- GStreamer output for all platforms +********************************************************************* + +.. inheritance-diagram:: mopidy.outputs.gstreamer + +.. automodule:: mopidy.outputs.gstreamer + :synopsis: GStreamer output for all platforms + :members: