diff --git a/docs/api/frontend.rst b/docs/api/frontend.rst index 27ce39a1..6a08c2bc 100644 --- a/docs/api/frontend.rst +++ b/docs/api/frontend.rst @@ -10,7 +10,7 @@ The following requirements applies to any frontend implementation: opening TCP ports and exposing Mopidy for a group of clients. - A frontend MUST implement at least one `Pykka - `_ actor, called the "main actor" from here + `_ actor, called the "main actor" from here on. - The main actor MUST accept two constructor arguments: diff --git a/docs/api/http.rst b/docs/api/http.rst index 4c4f9506..049f589f 100644 --- a/docs/api/http.rst +++ b/docs/api/http.rst @@ -61,7 +61,7 @@ JSON-RPC 2.0 messages JSON-RPC 2.0 messages can be recognized by checking for the key named ``jsonrpc`` with the string value ``2.0``. For details on the messaging format, please refer to the `JSON-RPC 2.0 spec -`_. +`_. All methods in the :ref:`core-api` is made available through JSON-RPC calls over the WebSocket. For example, :meth:`mopidy.core.PlaybackController.play` is diff --git a/docs/changelog.rst b/docs/changelog.rst index 5bd7613d..9314e379 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -33,6 +33,8 @@ Bug fix release. - Docs: Resize and compress images, reducing the release tarball size from 3.5 to 1.1 MB. +- Docs: Fix broken links. + v2.2.2 (2018-12-29) =================== diff --git a/docs/clients/mpd.rst b/docs/clients/mpd.rst index f4dd4006..c44d7cba 100644 --- a/docs/clients/mpd.rst +++ b/docs/clients/mpd.rst @@ -6,7 +6,7 @@ MPD clients This is a list of MPD clients we either know works well with Mopidy, or that we know won't work well. For a more exhaustive list of MPD clients, see -http://mpd.wikia.com/wiki/Clients. +https://mpd.fandom.com/wiki/Clients. .. contents:: Contents :local: @@ -72,7 +72,7 @@ with support for Linux, mac OS, and Windows. GMPC ---- -`GMPC `_ is a graphical MPD client (GTK+) which works +`GMPC `_ is a graphical MPD client (GTK+) which works well with Mopidy. .. image:: mpd-client-gmpc.jpg diff --git a/docs/clients/mpris.rst b/docs/clients/mpris.rst index eed23970..6bc911a4 100644 --- a/docs/clients/mpris.rst +++ b/docs/clients/mpris.rst @@ -4,7 +4,7 @@ MPRIS clients ************* -`MPRIS `_ is short +`MPRIS `_ is short for Media Player Remote Interfacing Specification. It is a spec that describes a standard D-Bus interface for making media players available to other applications on the same system. diff --git a/docs/clients/upnp.rst b/docs/clients/upnp.rst index 02deb316..735d7588 100644 --- a/docs/clients/upnp.rst +++ b/docs/clients/upnp.rst @@ -40,9 +40,9 @@ Using Mopidy-MPRIS and Rygel, or using Mopidy-MPD and upmpdcli. Mopidy-MPD and upmpdcli ----------------------- -`upmpdcli `_ is recommended, since it -is easier to setup, and offers `OpenHome -`_ compatibility. upmpdcli exposes a UPnP +`upmpdcli `_ is recommended, since it +is easier to setup, and offers `OpenHome +`_ compatibility. upmpdcli exposes a UPnP MediaRenderer to the network, while using the MPD protocol to control Mopidy. 1. Install upmpdcli. On Debian/Ubuntu:: diff --git a/docs/codestyle.rst b/docs/codestyle.rst index 26306631..0918dc97 100644 --- a/docs/codestyle.rst +++ b/docs/codestyle.rst @@ -21,7 +21,7 @@ Code style bar = 'I am a bytestring, but was it intentional?' - Follow :pep:`8` unless otherwise noted. `flake8 - `_ should be used to check your code + `_ should be used to check your code against the guidelines. - Use four spaces for indentation, *never* tabs. diff --git a/docs/contributing.rst b/docs/contributing.rst index 7c6f922b..53a976c9 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -19,9 +19,8 @@ Mopidy and its extensions: Just sign in and fire away. - Our IRC channel: `#mopidy `_ - on `irc.freenode.net `_, - with public `searchable logs `_. Be - prepared to hang around for a while, as we're not always around to answer + on `irc.freenode.net `_. + Be prepared to hang around for a while, as we're not always around to answer straight away. Before asking for help, it might be worth your time to read the @@ -119,13 +118,13 @@ Pull request guidelines `_ - `A Note About Git Commit Messages - `_ + `_ - `On commit messages `_ #. Send a pull request to the ``develop`` branch. See the `GitHub pull request - docs `_ for help. + docs `_ for help. .. note:: diff --git a/docs/devenv.rst b/docs/devenv.rst index 955bd77c..b0c236f0 100644 --- a/docs/devenv.rst +++ b/docs/devenv.rst @@ -54,7 +54,7 @@ your regular Mopidy install, which you set up in the first step, is unaffected by your hacking and will always be working. Most of us use the `virtualenvwrapper -`_ to ease working with +`_ to ease working with virtualenvs, so that's what we'll be using for the examples here. First, install and setup virtualenvwrapper as described in their docs. @@ -262,14 +262,14 @@ environments using the ``-e`` option, e.g. to run just unit tests:: tox -e py27 -To learn more, see the `tox documentation `_ . +To learn more, see the `tox documentation `_ . Running unit tests ------------------ -Under the hood, ``tox -e py27`` will use `pytest `_ as the -test runner. We can also use it directly to run all tests:: +Under the hood, ``tox -e py27`` will use `pytest `_ +as the test runner. We can also use it directly to run all tests:: pytest @@ -335,7 +335,7 @@ We're quite pedantic about :ref:`codestyle` and try hard to keep the Mopidy code base a very clean and nice place to work in. Luckily, you can get very far by using the `flake8 -`_ linter to check your code for issues before +`_ linter to check your code for issues before submitting a pull request. Mopidy passes all of flake8's checks, with only a very few exceptions configured in :file:`setup.cfg`. You can either run the ``flake8`` tox environment, like Travis CI will do on your pull request:: @@ -362,8 +362,8 @@ If successful, the command will not print anything at all. Writing documentation ===================== -To write documentation, we use `Sphinx `_. See their -site for lots of documentation on how to use Sphinx. +To write documentation, we use `Sphinx `_. See +their site for lots of documentation on how to use Sphinx. .. note:: @@ -509,7 +509,7 @@ For clarity, we can rename the ``origin`` remote to ``upstream``:: upstream https://github.com/mopidy/mopidy.git (push) If you haven't already, `fork the repository -`_ to your own GitHub account. +`_ to your own GitHub account. Then, add the new fork as a remote to your local clone:: @@ -553,7 +553,7 @@ When everything is done and committed, push the branch to your fork on GitHub:: Go to the repository on GitHub where you want the change merged, in this case https://github.com/mopidy/mopidy, and `create a pull request -`_. +`_. Updating a pull request diff --git a/docs/ext/backends.rst b/docs/ext/backends.rst index 74c04fb4..17450227 100644 --- a/docs/ext/backends.rst +++ b/docs/ext/backends.rst @@ -45,7 +45,7 @@ Mopidy-Beets https://github.com/mopidy/mopidy-beets Provides a backend for playing music from your `Beets -`_ music library through Beets' web extension. +`_ music library through Beets' web extension. Mopidy-Dirble @@ -151,7 +151,7 @@ Mopidy-Podcast-gpodder https://github.com/tkem/mopidy-podcast-gpodder Extension for Mopidy-Podcast that lets you search and browse podcasts from the -`gpodder `_ web site. +`gpodder `_ web site. Mopidy-Podcast-iTunes @@ -169,8 +169,8 @@ Mopidy-radio-de https://github.com/hechtus/mopidy-radio-de Extension for listening to Internet radio stations and podcasts listed at -`radio.de `_, `radio.net `_, -`radio.fr `_, and `radio.at `_. +`radio.de `_, `radio.net `_, +`radio.fr `_, and `radio.at `_. Mopidy-RNZ @@ -178,7 +178,7 @@ Mopidy-RNZ https://github.com/danbrough/mopidy-rnz -Extension for playing `Radio New Zealands `_ +Extension for playing `Radio New Zealands `_ podcasts,live streams and latest news bulletin. @@ -240,7 +240,7 @@ Mopidy-TuneIn https://github.com/kingosticks/mopidy-tunein Provides a backend for playing music from the `TuneIn -`_ online radio service. +`_ online radio service. Mopidy-VKontakte diff --git a/docs/ext/frontends.rst b/docs/ext/frontends.rst index 1cde7041..3b07856c 100644 --- a/docs/ext/frontends.rst +++ b/docs/ext/frontends.rst @@ -55,7 +55,7 @@ Mopidy-Touchscreen https://github.com/9and3r/mopidy-touchscreen Extension for displaying track info and controlling Mopidy from a touch screen -using `PyGame `_/SDL. +using `PyGame `_/SDL. Mopidy-TtsGpio diff --git a/docs/ext/http.rst b/docs/ext/http.rst index 855a8c6b..9b9d1bfc 100644 --- a/docs/ext/http.rst +++ b/docs/ext/http.rst @@ -111,8 +111,8 @@ See :ref:`config` for general help on configuring Mopidy. allowed and so you don't need an entry for those. However, if your requests originate from a different web server, you will need to add an entry for that server in this list. For example, to allow requests from a web server - at 'http://www.my.web-client.com' you would specify the entry - 'www.my.web-client.com'. + at 'http://my-web-client.example.com' you would specify the entry + 'my-web-client.example.com'. .. confval:: http/csrf_protection diff --git a/docs/ext/web.rst b/docs/ext/web.rst index 053b7d47..cd09a9a2 100755 --- a/docs/ext/web.rst +++ b/docs/ext/web.rst @@ -162,7 +162,7 @@ https://github.com/pimusicbox/mopidy-musicbox-webclient The first web client for Mopidy, made with jQuery Mobile by Wouter van Wijk. Also the web client used for Wouter's popular `Pi Musicbox -`_ image for Raspberry Pi. +`_ image for Raspberry Pi. .. image:: /ext/musicbox_webclient.jpg :width: 696 @@ -225,7 +225,7 @@ Bootstrap by Wojciech Wnętrzak. :width: 696 :height: 343 -To use, just visit http://mopster.cowbell-labs.com/. +To use, just visit http://mopster.urizen.pl/. Mopidy-Jukepi diff --git a/docs/extensiondev.rst b/docs/extensiondev.rst index f5929ec4..0d78512d 100644 --- a/docs/extensiondev.rst +++ b/docs/extensiondev.rst @@ -32,7 +32,7 @@ named Soundspot to Mopidy, you would name your extension's Python package ``mopidy_soundspot``. The extension must be shipped with a ``setup.py`` file and be registered on -`PyPI `_. The name of the distribution on PyPI would +`PyPI `_. The name of the distribution on PyPI would be something like "Mopidy-Soundspot". Make sure to include the name "Mopidy" somewhere in that name and that you check the capitalization. This is the name users will use when they install your extension from PyPI. @@ -61,7 +61,7 @@ Example content for the most important files follows below. cookiecutter project template ============================= -We've also made a `cookiecutter `_ +We've also made a `cookiecutter `_ project template for `creating new Mopidy extensions `_. If you install cookiecutter and run a single command, you're asked a few questions about the @@ -215,7 +215,7 @@ file:: For details on the ``MANIFEST.in`` file format, check out the `distutils docs `_. -`check-manifest `_ is a very +`check-manifest `_ is a very useful tool to check your ``MANIFEST.in`` file for completeness. @@ -485,7 +485,7 @@ If you make HTTP requests please make sure to respect the :ref:`proxy configs configured by the Mopidy user. To make this easier for extension developers, the helper function :func:`mopidy.httpclient.format_proxy` was added in Mopidy 1.1. This function returns the proxy settings `formatted the way Requests -expects `__. +expects `__. User-Agent strings ------------------ @@ -505,7 +505,7 @@ Example using Requests sessions ------------------------------- Most Mopidy extensions that make HTTP requests use the `Requests -`_ library to do so. When using Requests, the +`_ library to do so. When using Requests, the most convenient way to make sure the proxy and User-Agent header is set properly is to create a Requests session object and use that object to make all your HTTP requests:: @@ -541,7 +541,7 @@ your HTTP requests:: # ``session`` object. For further details, see Requests' docs on `session objects -`__. +`__. Testing extensions ================== @@ -554,8 +554,8 @@ extension in some unanticipated way. Before getting started, it is important to familiarize yourself with the Python `mock library `_. When it comes to running tests, Mopidy typically makes use of testing tools -like `tox `_ and -`pytest `_. +like `tox `_ and +`pytest `_. Testing approach ---------------- @@ -646,9 +646,9 @@ file, and mocking the audio actor:: The following libraries might be useful for mocking any HTTP requests that your extension makes: -- `responses `_ - A utility library for +- `responses `_ - A utility library for mocking out the requests Python library. -- `vcrpy `_ - Automatically mock your HTTP +- `vcrpy `_ - Automatically mock your HTTP interactions to simplify and speed up testing. At the very least, you'll probably want to patch ``requests`` or any other web diff --git a/docs/history/changelog-0.x.rst b/docs/history/changelog-0.x.rst index 1724899e..d550d7ff 100644 --- a/docs/history/changelog-0.x.rst +++ b/docs/history/changelog-0.x.rst @@ -1897,7 +1897,8 @@ Please note that 0.6.0 requires some updated dependencies, as listed under subsystems: player, playlist, options, and mixer. (Fixes: :issue:`32`) - A new frontend :mod:`mopidy.frontends.mpris` have been added. It exposes - Mopidy through the `MPRIS interface `_ over D-Bus. In + Mopidy through the `MPRIS interface + `_ over D-Bus. In practice, this makes it possible to control Mopidy through the `Ubuntu Sound Menu `_. @@ -2080,7 +2081,7 @@ loading from Mopidy 0.3.0 is still present. **Important changes** -- Mopidy now depends on `Pykka `_ >=0.12. If you +- Mopidy now depends on `Pykka `_ >=0.12. If you install from APT, Pykka will automatically be installed. If you are not installing from APT, you may install Pykka from PyPI:: @@ -2340,11 +2341,11 @@ This is a maintenance release without any new features. v0.2.0 (2010-10-24) =================== -In Mopidy 0.2.0 we've added a `Last.fm `_ scrobbling +In Mopidy 0.2.0 we've added a `Last.fm `_ scrobbling support, which means that Mopidy now can submit meta data about the tracks you play to your Last.fm profile. See :mod:`mopidy.frontends.lastfm` for details on new dependencies and settings. If you use Mopidy's Last.fm support, -please join the `Mopidy group at Last.fm `_. +please join the `Mopidy group at Last.fm `_. With the exception of the work on the Last.fm scrobbler, there has been a couple of quiet months in the Mopidy camp. About the only thing going on, has diff --git a/docs/index.rst b/docs/index.rst index dccb07c5..bcbd7956 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -60,8 +60,7 @@ To get started with Mopidy, start by reading :ref:`installation`. If you get stuck, you can get help at the `Mopidy discussion forum `_. We also hang around at IRC on the -``#mopidy`` channel at `irc.freenode.net `_. The IRC -channel has `public searchable logs `_. +``#mopidy`` channel at `irc.freenode.net `_. If you stumble into a bug or have a feature request, please create an issue in the `issue tracker `_. If you're diff --git a/docs/installation/osx.rst b/docs/installation/osx.rst index bedadba2..d39da5e0 100644 --- a/docs/installation/osx.rst +++ b/docs/installation/osx.rst @@ -9,7 +9,7 @@ If you are running OS X, you can install everything needed with Homebrew. xcode-select --install -#. Install `Homebrew `_. +#. Install `Homebrew `_. #. If you are already using Homebrew, make sure your installation is up to date before you continue:: diff --git a/docs/installation/raspberrypi.rst b/docs/installation/raspberrypi.rst index 685eb0d0..5392fdd5 100644 --- a/docs/installation/raspberrypi.rst +++ b/docs/installation/raspberrypi.rst @@ -18,7 +18,7 @@ How to for Raspbian =================== #. Download the latest Raspbian Desktop or Lite disk image from - http://www.raspberrypi.org/downloads/raspbian/. + https://www.raspberrypi.org/downloads/raspbian/. Unless you need a full graphical desktop the Lite image is preferable since it's much smaller. @@ -88,5 +88,5 @@ You can test sound output independent of Mopidy by running:: If you hear a voice saying "Front Center", then your sound is working. -If you want to change your audio output setting, simply rerun ``sudo +If you want to change your audio output setting, simply rerun ``sudo raspi-config``. diff --git a/docs/installation/source.rst b/docs/installation/source.rst index ee2ffad5..19796994 100644 --- a/docs/installation/source.rst +++ b/docs/installation/source.rst @@ -71,7 +71,7 @@ please follow the directions :ref:`here `. sudo pip install -U mopidy This will use ``pip`` to install the latest release of `Mopidy from PyPI - `_. To upgrade Mopidy to future + `_. To upgrade Mopidy to future releases, just rerun this command. #. Finally, you need to set a couple of :doc:`config values `, and diff --git a/docs/service.rst b/docs/service.rst index 10c47a68..11bef120 100644 --- a/docs/service.rst +++ b/docs/service.rst @@ -101,7 +101,7 @@ When using PulseAudio, you will typically have a PulseAudio server run by your main user. Since Mopidy is running as its own user, it can't access this server directly. Running PulseAudio as a system-wide daemon is discouraged by upstream (see `here -`_ +`_ for details). Rather you can configure PulseAudio and Mopidy so Mopidy sends the sound to the PulseAudio server already running as your main user. diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 5cc23d65..fd3abecb 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -18,7 +18,7 @@ Sharing config and log output ============================= If you're getting help at IRC, we recommend that you use a pastebin, like -`pastebin.com `_ or `GitHub Gist +`pastebin.com `_ or `GitHub Gist `_, to share your configuration and log output. Pasting more than a couple of lines on IRC is generally frowned upon. On the mailing list or when reporting an issue, somewhat longer text dumps are @@ -79,7 +79,7 @@ Debugging GStreamer If you really want to dig in and debug GStreamer behaviour, then check out the `Debugging section -`_ +`_ of GStreamer's documentation for your options. Note that Mopidy does not support the GStreamer command line options, like ``--gst-debug-level=3``, but setting GStreamer environment variables, like :envvar:`GST_DEBUG`, works with diff --git a/docs/versioning.rst b/docs/versioning.rst index bc93275b..0c2c36bc 100644 --- a/docs/versioning.rst +++ b/docs/versioning.rst @@ -4,7 +4,7 @@ Versioning ********** -Mopidy follows `Semantic Versioning `_. In summary this +Mopidy follows `Semantic Versioning `_. In summary this means that our version numbers have three parts, MAJOR.MINOR.PATCH, which change according to the following rules: diff --git a/mopidy/audio/actor.py b/mopidy/audio/actor.py index a837f790..62b1fe3e 100644 --- a/mopidy/audio/actor.py +++ b/mopidy/audio/actor.py @@ -396,7 +396,7 @@ class _Handler(object): class Audio(pykka.ThreadingActor): """ - Audio output through `GStreamer `_. + Audio output through `GStreamer `_. """ #: The GStreamer state mapped to :class:`mopidy.audio.PlaybackState` diff --git a/mopidy/mpd/protocol/__init__.py b/mopidy/mpd/protocol/__init__.py index aab8ed8d..e36f1342 100644 --- a/mopidy/mpd/protocol/__init__.py +++ b/mopidy/mpd/protocol/__init__.py @@ -5,9 +5,9 @@ This is partly based upon the `MPD protocol documentation `_, which is a useful resource, but it is rather incomplete with regards to data formats, both for requests and responses. Thus, we have had to talk a great deal with the the original `MPD -server `_ using telnet to get the details we need to +server `_ using telnet to get the details we need to implement our own MPD server which is compatible with the numerous existing -`MPD clients `_. +`MPD clients `_. """ from __future__ import absolute_import, unicode_literals diff --git a/mopidy/mpd/protocol/playback.py b/mopidy/mpd/protocol/playback.py index 08e7cded..a0562903 100644 --- a/mopidy/mpd/protocol/playback.py +++ b/mopidy/mpd/protocol/playback.py @@ -42,7 +42,8 @@ def mixrampdb(context, decibels): doesn't fade the track volume, just overlaps. The songs need to have MixRamp tags added by an external tool. 0dB is the normalized maximum volume so use negative values, I prefer -17dB. In the absence of mixramp - tags crossfading will be used. See http://sourceforge.net/projects/mixramp + tags crossfading will be used. See + https://sourceforge.net/projects/mixramp/ """ raise exceptions.MpdNotImplemented # TODO