From 8ebe9f59fd0f707a620b525386ebf9466e723fc5 Mon Sep 17 00:00:00 2001 From: Gustaf Hallberg Date: Wed, 21 Oct 2015 21:32:21 +0200 Subject: [PATCH] Run sphinx linkcheck in tox. Fixes for a bunch of fixes for such. --- docs/changelog.rst | 6 +++--- docs/clients/mpd.rst | 12 ++++-------- docs/clients/mpris.rst | 4 ++-- docs/clients/upnp.rst | 6 +++--- docs/codestyle.rst | 2 +- docs/conf.py | 13 +++++++++++-- docs/config.rst | 2 +- docs/devenv.rst | 6 +++--- docs/ext/backends.rst | 26 +++++++++++++------------- docs/ext/web.rst | 4 ++-- docs/extensiondev.rst | 2 +- docs/installation/raspberrypi.rst | 4 ++-- docs/running.rst | 4 ---- tox.ini | 1 + 14 files changed, 47 insertions(+), 45 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 0d23a608..878dc631 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -2053,7 +2053,7 @@ already have. - Mopidy.js now works both from browsers and from Node.js environments. This means that you now can make Mopidy clients in Node.js. Mopidy.js has been - published to the `npm registry `_ for easy + published to the `npm registry `_ for easy installation in Node.js projects. - Upgrade Mopidy.js' build system Grunt from 0.3 to 0.4. @@ -2809,9 +2809,9 @@ 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 `_. + Menu `_. **Changes** diff --git a/docs/clients/mpd.rst b/docs/clients/mpd.rst index fe7ef21d..dd733af2 100644 --- a/docs/clients/mpd.rst +++ b/docs/clients/mpd.rst @@ -59,7 +59,7 @@ MPD graphical clients 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.png @@ -76,7 +76,7 @@ before it will catch up. Sonata ------ -`Sonata `_ is a graphical MPD client (GTK+). +`Sonata `_ is a graphical MPD client (GTK+). It generally works well with Mopidy, except for search. .. image:: mpd-client-sonata.png @@ -87,11 +87,7 @@ When you search in Sonata, it only sends the first to letters of the search query to Mopidy, and then does the rest of the filtering itself on the client side. Since Spotify has a collection of millions of tracks and they only return the first 100 hits for any search query, searching for two-letter combinations -seldom returns any useful results. See :issue:`1` and the closed `Sonata bug`_ -for details. - -.. _Sonata bug: http://developer.berlios.de/feature/?func=detailfeature&feature_id=5038&group_id=7323 - +seldom returns any useful results. See :issue:`1` for details. Theremin -------- @@ -171,5 +167,5 @@ projects are a real match made in heaven." Partify ------- -`Partify `_ is a web based MPD client focusing on +`Partify `_ is a web based MPD client focusing on making music playing collaborative and social. diff --git a/docs/clients/mpris.rst b/docs/clients/mpris.rst index aef02566..1948afe4 100644 --- a/docs/clients/mpris.rst +++ b/docs/clients/mpris.rst @@ -4,7 +4,7 @@ MPRIS clients ************* -`MPRIS `_ is short for Media Player Remote Interfacing +`MPRIS `_ is short for Media Player Remote Interfacing Specification. It's a spec that describes a standard D-Bus interface for making media players available to other applications on the same system. @@ -19,7 +19,7 @@ implement the optional tracklist interface. Ubuntu Sound Menu ================= -The `Ubuntu Sound Menu `_ is the default +The `Ubuntu Sound Menu `_ is the default sound menu in Ubuntu since 10.10 or 11.04. By default, it only includes the Rhytmbox music player, but many other players can integrate with the sound menu, including the official Spotify player and Mopidy. diff --git a/docs/clients/upnp.rst b/docs/clients/upnp.rst index b5b18268..1a33b456 100644 --- a/docs/clients/upnp.rst +++ b/docs/clients/upnp.rst @@ -4,11 +4,11 @@ UPnP clients ************ -`UPnP `_ is a set of +`UPnP `_ is a set of specifications for media sharing, playing, remote control, etc, across a home network. The specs are supported by a lot of consumer devices (like smartphones, TVs, Xbox, and PlayStation) that are often labeled as being `DLNA -`_ compatible or certified. +`_ compatible or certified. The DLNA guidelines and UPnP specifications defines several device roles, of which Mopidy may play two: @@ -149,4 +149,4 @@ Other clients For a long list of UPnP clients for all possible platforms, see Wikipedia's `List of UPnP AV media servers and clients -`_. +`_. diff --git a/docs/codestyle.rst b/docs/codestyle.rst index 4b6e7448..26306631 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/conf.py b/docs/conf.py index cbb2f228..0786e33d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -167,7 +167,16 @@ extlinks = { # -- Options for intersphinx extension ---------------------------------------- intersphinx_mapping = { - 'python': ('http://docs.python.org/2', None), - 'pykka': ('http://www.pykka.org/en/latest/', None), + 'python': ('https://docs.python.org/2', None), + 'pykka': ('https://www.pykka.org/en/latest/', None), 'tornado': ('http://www.tornadoweb.org/en/stable/', None), } + +# -- Options for linkcheck builder ------------------------------------------- + +linkcheck_ignore = [ #Some sites work in browser but linkcheck fails. + r'http://localhost:\d+/', + r'http://wiki.commonjs.org', + r'http://vk.com', + r'http://$'] +linkcheck_anchors = False #This breaks on links that use # for other stuff diff --git a/docs/config.rst b/docs/config.rst index 7f0bda31..292a6a09 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -195,7 +195,7 @@ Logging configuration to use for that logger, one of ``black``, ``red``, ``green``, ``yellow``, ``blue``, ``magenta``, ``cyan`` or ``white``. -.. _the Python logging docs: http://docs.python.org/2/library/logging.config.html +.. _the Python logging docs: https://docs.python.org/2/library/logging.config.html .. _proxy-config: diff --git a/docs/devenv.rst b/docs/devenv.rst index c00e6050..cd67690b 100644 --- a/docs/devenv.rst +++ b/docs/devenv.rst @@ -300,7 +300,7 @@ the given module, ``mopidy`` in this example, are covered by the test suite:: .. note:: Up to date test coverage statistics can also be viewed online at - `coveralls.io `_. + `coveralls.io `_. If we want to speed up the test suite, we can even get a list of the ten slowest tests:: @@ -322,7 +322,7 @@ CI, and the build status will be visible in the GitHub pull request interface, making it easier to evaluate the quality of pull requests. For each successful build, Travis submits code coverage data to `coveralls.io -`_. If you're out of work, coveralls might +`_. If you're out of work, coveralls might help you find areas in the code which could need better test coverage. @@ -392,7 +392,7 @@ OS:: open _build/html/index.html # OS X The documentation at https://docs.mopidy.com/ is hosted by `Read the Docs -`_, which automatically updates the documentation +`_, which automatically updates the documentation when a change is pushed to the ``mopidy/mopidy`` repo at GitHub. diff --git a/docs/ext/backends.rst b/docs/ext/backends.rst index 5f578e6f..492ab842 100644 --- a/docs/ext/backends.rst +++ b/docs/ext/backends.rst @@ -54,7 +54,7 @@ Mopidy-Dirble https://github.com/mopidy/mopidy-dirble Provides a backend for browsing the Internet radio channels from the `Dirble -`_ directory. +`_ directory. Mopidy-dLeyna @@ -63,7 +63,7 @@ Mopidy-dLeyna https://github.com/tkem/mopidy-dleyna Provides a backend for playing music from Digital Media Servers using -the `dLeyna `_ D-Bus interface. +the `dLeyna `_ D-Bus interface. Mopidy-File =========== @@ -76,13 +76,13 @@ Mopidy-Grooveshark https://github.com/camilonova/mopidy-grooveshark Provides a backend for playing music from `Grooveshark -`_. +`_. Mopidy-GMusic ============= -https://github.com/hechtus/mopidy-gmusic +https://github.com/mopidy/mopidy-gmusic Provides a backend for playing music from `Google Play Music `_. @@ -153,13 +153,13 @@ https://github.com/tkem/mopidy-podcast Extension for browsing RSS feeds of podcasts and stream the episodes. -Mopidy-Podcast-gpodder.net +Mopidy-Podcast-gpodder ========================== https://github.com/tkem/mopidy-podcast-gpodder Extension for Mopidy-Podcast that lets you search and browse podcasts from the -`gpodder.net `_ web site. +`gpodder `_ web site. Mopidy-Podcast-iTunes @@ -177,7 +177,7 @@ Mopidy-radio-de https://github.com/hechtus/mopidy-radio-de Extension for listening to Internet radio stations and podcasts listed at -`radio.de `_, `rad.io `_, +`radio.de `_, `radio.net `_, `radio.fr `_, and `radio.at `_. @@ -196,7 +196,7 @@ Mopidy-SoundCloud https://github.com/mopidy/mopidy-soundcloud Provides a backend for playing music from the `SoundCloud -`_ service. +`_ service. Mopidy-Spotify @@ -204,7 +204,7 @@ Mopidy-Spotify https://github.com/mopidy/mopidy-spotify -Extension for playing music from the `Spotify `_ music +Extension for playing music from the `Spotify `_ music streaming service. @@ -214,7 +214,7 @@ Mopidy-Spotify-Tunigo https://github.com/trygveaa/mopidy-spotify-tunigo Extension for providing the browse feature of `Spotify -`_. This lets you browse playlists, genres and new +`_. This lets you browse playlists, genres and new releases. @@ -239,7 +239,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 @@ -254,7 +254,7 @@ Provides a backend for playing music from the `VKontakte social network Mopidy-YouTube ============== -https://github.com/dz0ny/mopidy-youtube +https://github.com/mopidy/mopidy-youtube Provides a backend for playing music from the `YouTube -`_ service. +`_ service. diff --git a/docs/ext/web.rst b/docs/ext/web.rst index bf29bf72..b0659b05 100644 --- a/docs/ext/web.rst +++ b/docs/ext/web.rst @@ -118,7 +118,7 @@ To install, run:: Mopidy-MusicBox-Webclient ========================= -https://github.com/woutervanwijk/Mopidy-MusicBox-Webclient +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 @@ -153,7 +153,7 @@ To install, run:: Mopidy-WebSettings ================== -https://github.com/woutervanwijk/mopidy-websettings +https://github.com/pimusicbox/mopidy-websettings A web extension for changing settings. Used by the Pi MusicBox distribution for Raspberry Pi, but also usable for other projects. diff --git a/docs/extensiondev.rst b/docs/extensiondev.rst index 77fd69fd..f797368f 100644 --- a/docs/extensiondev.rst +++ b/docs/extensiondev.rst @@ -214,7 +214,7 @@ file:: include mopidy_soundspot/ext.conf For details on the ``MANIFEST.in`` file format, check out the `distutils docs -`_. +`_. `check-manifest `_ is a very useful tool to check your ``MANIFEST.in`` file for completeness. diff --git a/docs/installation/raspberrypi.rst b/docs/installation/raspberrypi.rst index c8793496..495b0776 100644 --- a/docs/installation/raspberrypi.rst +++ b/docs/installation/raspberrypi.rst @@ -4,7 +4,7 @@ Raspberry Pi: Mopidy on a credit card ************************************* -Mopidy runs nicely on a `Raspberry Pi `_. As of +Mopidy runs nicely on a `Raspberry Pi `_. As of January 2013, Mopidy will run with Spotify support on both the armel (soft-float) and armhf (hard-float) architectures, which includes the Raspbian distribution. @@ -28,7 +28,7 @@ If you don't know which one to select, go for the armhf variant, as it'll give you a lot better performance. #. Download the latest "wheezy" disk image from - http://www.raspberrypi.org/downloads/. This was last tested with the images + https://www.raspberrypi.org/downloads/. This was last tested with the images from 2013-05-25 for armhf and 2013-05-29 for armel. #. Flash the OS image to your SD card. See diff --git a/docs/running.rst b/docs/running.rst index e329ccaa..73bd211f 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -51,9 +51,5 @@ Init scripts `__ comes with a systemd init script. -- A blog post by Benjamin Guillet explains how to `Daemonize Mopidy and Launch - It at Login on OS X - `_. - - Issue :issue:`266` contains a bunch of init scripts for Mopidy, including Upstart init scripts. diff --git a/tox.ini b/tox.ini index ecc358ac..55863275 100644 --- a/tox.ini +++ b/tox.ini @@ -33,6 +33,7 @@ deps = deps = -r{toxinidir}/docs/requirements.txt changedir = docs commands = sphinx-build -b html -d {envtmpdir}/doctrees . {envtmpdir}/html + sphinx-build -b linkcheck -d {envtmpdir}/doctrees . {envtmpdir}/html [testenv:flake8] deps =