Skip to content

Commit

Permalink
docs: fix links that were failing sphinx' linkcheck
Browse files Browse the repository at this point in the history
There's one stale link left for the gmusic plugin, which should be fixed
by removing the plugin, see beetbox#4089
  • Loading branch information
wisp3rwind committed Oct 4, 2021
1 parent 9bab200 commit c8bfad5
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ Code Contribution Ideas
places to think about performance optimization (see
`Optimization <https://github.com/beetbox/beets/wiki/Optimization>`__).
- Not all of our code is up to our coding conventions. In particular,
the `API
documentation <https://beets.readthedocs.io/en/stable/dev/api.html>`__
the `library API
documentation <https://beets.readthedocs.io/en/stable/dev/library.html>`__
are currently quite sparse. You can help by adding to the docstrings
in the code and to the documentation pages themselves. beets follows
`PEP-257 <https://www.python.org/dev/peps/pep-0257/>`__ for
Expand Down Expand Up @@ -159,9 +159,9 @@ documentation, and the changelog entry. Thank you for contributing!
The Code
========

The documentation has an `API
section <https://beets.readthedocs.io/en/stable/dev/api.html>`__ that
serves as an introduction to beets’ design.
The documentation has a section on the
`library API <https://beets.readthedocs.io/en/stable/dev/library.html>`__
that serves as an introduction to beets’ design.

Coding Conventions
==================
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
r'https://github.com/beetbox/beets/issues/',
r'https://github.com/[^/]+$', # ignore user pages
r'.*localhost.*',
r'https?://127\.0\.0\.1',
r'https://www.musixmatch.com/', # blocks requests
r'https://genius.com/', # blocks requests
]
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/spotify.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Also, the plugin can use the Spotify `Album`_ and `Track`_ APIs to provide
metadata matches for the importer.

.. _Spotify: https://www.spotify.com/
.. _Spotify Search API: https://developer.spotify.com/documentation/web-api/reference/search/search/
.. _Album: https://developer.spotify.com/documentation/web-api/reference/albums/get-album/
.. _Track: https://developer.spotify.com/documentation/web-api/reference/tracks/get-track/
.. _Spotify Search API: https://developer.spotify.com/documentation/web-api/reference/#category-search
.. _Album: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-an-album
.. _Track: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-track

Why Use This Plugin?
--------------------
Expand Down

0 comments on commit c8bfad5

Please sign in to comment.