diff --git a/docs/api/audio.rst b/docs/api/audio.rst index 2b9f6cc5..550ca890 100644 --- a/docs/api/audio.rst +++ b/docs/api/audio.rst @@ -28,3 +28,10 @@ Audio listener .. autoclass:: mopidy.audio.AudioListener :members: + + +Audio scanner +============= + +.. autoclass:: mopidy.audio.scan.Scanner + :members: diff --git a/docs/api/commands.rst b/docs/api/commands.rst new file mode 100644 index 00000000..f0469350 --- /dev/null +++ b/docs/api/commands.rst @@ -0,0 +1,9 @@ +.. _commands-api: + +************ +Commands API +************ + +.. automodule:: mopidy.commands + :synopsis: Commands API for Mopidy CLI. + :members: diff --git a/docs/api/index.rst b/docs/api/index.rst index bb29890b..f58552b7 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -13,6 +13,7 @@ API reference core audio frontends + commands ext config http diff --git a/docs/changelog.rst b/docs/changelog.rst index cbb44afe..04c5eaa1 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -74,6 +74,21 @@ v0.17.0 (UNRELEASED) :confval:`http/zeroconf` config value to change the service name or disable the service. (Fixes: :issue:`39`) +**Sub-commands** + +- Switched to sub-commands for the ``mopidy`` command , this implies the + following changes (fixes :issue:`437`): + + ===================== ================= + Old command New command + ===================== ================= + mopidy --show-deps mopidy deps + mopidy --show-config mopidy config + mopidy-scan mopidy local scan + +- Added hooks for extensions to create their own custom sub-commands and + converted ``mopidy-scan`` as first user of new API. (Fixes :issue:`436`) + v0.16.1 (2013-11-02) ==================== diff --git a/docs/commands/mopidy-scan.rst b/docs/commands/mopidy-scan.rst deleted file mode 100644 index e8c25f77..00000000 --- a/docs/commands/mopidy-scan.rst +++ /dev/null @@ -1,59 +0,0 @@ -.. _mopidy-scan-cmd: - -******************* -mopidy-scan command -******************* - -Synopsis -======== - -mopidy-scan - [-h] [--version] [-q] [-v] - - -Description -=========== - -Mopidy is a music server which can play music both from multiple sources, like -your local hard drive, radio streams, and from Spotify and SoundCloud. Searches -combines results from all music sources, and you can mix tracks from all -sources in your play queue. Your playlists from Spotify or SoundCloud are also -available for use. - -The ``mopidy-scan`` command is used to index a music library to make it -available for playback with ``mopidy``. - - -Options -======= - -.. program:: mopidy-scan - -.. cmdoption:: --version - - Show Mopidy's version number and exit. - -.. cmdoption:: -h, --help - - Show help message and exit. - -.. cmdoption:: -q, --quiet - - Show less output: warning level and higher. - -.. cmdoption:: -v, --verbose - - Show more output: debug level and higher. - - -See also -======== - -:ref:`mopidy(1) ` - - -Reporting bugs -============== - -Report bugs to Mopidy's issue tracker at - diff --git a/docs/commands/mopidy.rst b/docs/commands/mopidy.rst index df4766c3..e5089b2c 100644 --- a/docs/commands/mopidy.rst +++ b/docs/commands/mopidy.rst @@ -8,8 +8,8 @@ Synopsis ======== mopidy - [-h] [--version] [-q] [-v] [--save-debug-log] [--show-config] - [--show-deps] [--config CONFIG_FILES] [-o CONFIG_OVERRIDES] + [-h] [--version] [-q] [-v] [--save-debug-log] [--config CONFIG_FILES] + [-o CONFIG_OVERRIDES] [COMMAND] ... Description @@ -50,20 +50,10 @@ Options Save debug log to the file specified in the :confval:`logging/debug_file` config value, typically ``./mopidy.log``. -.. cmdoption:: --show-config - - Show the current effective config. All configuration sources are merged - together to show the effective document. Secret values like passwords are - masked out. Config for disabled extensions are not included. - -.. cmdoption:: --show-deps - - Show dependencies, their versions and installation location. - .. cmdoption:: --config Specify config file to use. To use multiple config files, separate them - with colon. The later files override the earlier ones if there's a + with a colon. The later files override the earlier ones if there's a conflict. .. cmdoption:: -o