diff --git a/docs/changelog.rst b/docs/changelog.rst index 894b5883..6a4ab026 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -47,11 +47,17 @@ and improved. as extensions, but they are still distributed together with Mopidy and are enabled by default. +- The NAD mixer have been moved out of Mopidy core to its own project, + Mopidy-NAD. See :ref:`ext` for more information. + **Command line options** - The command option :option:`mopidy --list-settings` is now named :option:`mopidy --show-config`. +- The command option :option:`mopidy --list-deps` is now named + :option:`mopidy --show-deps`. + - What configuration files to use can now be specified through the command option :option:`mopidy --config`. diff --git a/docs/config.rst b/docs/config.rst index 3b31f0dd..e1affe5b 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -28,9 +28,9 @@ the config values you want to change. If you want to keep the default for a config value, you **should not** add it to ``~/.config/mopidy/mopidy.conf``. To see what's the effective configuration for your Mopidy installation, you can -run ``mopidy --show-config``. It will print your full effective config with -passwords masked out so that you safely can share the output with others for -debugging. +run :option:`mopidy --show-config`. It will print your full effective config +with passwords masked out so that you safely can share the output with others +for debugging. You can find a description of all config values belonging to Mopidy's core below, together with their default values. In addition, all :ref:`extensions @@ -95,13 +95,13 @@ Core configuration values .. confval:: logging/debug_file The file to dump debug log data to when Mopidy is run with the - :option:`--save-debug-log` option. + :option:`mopidy --save-debug-log` option. -.. confval:: logging.levels/* +.. confval:: loglevels/* - The ``logging.levels`` config section can be used to change the log level - for specific parts of Mopidy during development or debugging. Each key in - the config section should match the name of a logger. The value is the log + The ``loglevels`` config section can be used to change the log level for + specific parts of Mopidy during development or debugging. Each key in the + config section should match the name of a logger. The value is the log level to use for that logger, one of ``debug``, ``info``, ``warning``, ``error``, or ``critical``. diff --git a/docs/devtools.rst b/docs/devtools.rst index 7b5b2f81..bc066cd0 100644 --- a/docs/devtools.rst +++ b/docs/devtools.rst @@ -40,7 +40,8 @@ sends all requests to both, returning the primary response to the client and then printing any diff in the two responses. Note that this tool depends on ``gevent`` unlike the rest of Mopidy at the time -of writing. See ``--help`` for available options. Sample session:: +of writing. See :option:`tools/debug-proxy.py --help` for available options. +Sample session:: [127.0.0.1]:59714 listallinfo diff --git a/docs/ext/index.rst b/docs/ext/index.rst index af51e9bb..4cfdbbe0 100644 --- a/docs/ext/index.rst +++ b/docs/ext/index.rst @@ -30,6 +30,21 @@ These extensions are maintained outside Mopidy's core, often by other developers. +Mopidy-NAD +---------- + +Extension for controlling volume using an external NAD amplifier. + +Author: + Stein Magnus Jodal +PyPI: + `Mopidy-NAD `_ +GitHub: + `mopidy/mopidy-nad `_ +Issues: + https://github.com/mopidy/mopidy/issues + + Mopidy-SoundCloud ----------------- @@ -42,3 +57,5 @@ PyPI: `Mopidy-SoundCloud `_ GitHub: `dz0ny/mopidy-soundcloud `_ +Issues: + https://github.com/dz0ny/mopidy-soundcloud/issues diff --git a/docs/extensiondev.rst b/docs/extensiondev.rst index d705cd60..19bba824 100644 --- a/docs/extensiondev.rst +++ b/docs/extensiondev.rst @@ -230,12 +230,12 @@ and ``password``. version = __version__ def get_default_config(self): - return default_config + return bytes(default_config) def get_config_schema(self): schema = super(Extension, self).get_config_schema() - schema['username'] = config.String(required=True) - schema['password'] = config.String(required=True, secret=True) + schema['username'] = config.String() + schema['password'] = config.Secret() return schema def validate_environment(self): @@ -365,4 +365,4 @@ Is much better than:: If you want to turn on debug logging for your own extension, but not for everything else due to the amount of noise, see the docs for the -:confval:`logging.levels/*` config section. +:confval:`loglevels/*` config section. diff --git a/docs/modules/audio/mixers/nad.rst b/docs/modules/audio/mixers/nad.rst deleted file mode 100644 index 661dc723..00000000 --- a/docs/modules/audio/mixers/nad.rst +++ /dev/null @@ -1,6 +0,0 @@ -********************************************* -:mod:`mopidy.audio.mixers.nad` -- NAD mixer -********************************************* - -.. automodule:: mopidy.audio.mixers.nad - :synopsis: Mixer element for controlling volume on NAD amplifiers diff --git a/docs/running.rst b/docs/running.rst index b81dbef7..7e0bacbb 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -25,7 +25,48 @@ mopidy command .. program:: mopidy -TODO: Document all command line options +.. cmdoption:: --version + + Show Mopidy's version number and exit. + +.. cmdoption:: -h, --help + + Show help message and exit. + +.. cmdoption:: -q, --quite + + Show less output: warning level and higher. + +.. cmdoption:: -v, --verbose + + Show more output: debug level and higher. + +.. cmdoption:: --save-debug-log + + Save debug log to the file specified in the :confval:`logging/debug_file` + config value, typically ``./mopidy.conf``. + +.. 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 + conflict. + +.. cmdoption:: -o