From 1411510d555c6af8b2de32ddeadd59a87f416644 Mon Sep 17 00:00:00 2001 From: Pieter Lenaerts Date: Sat, 3 Jun 2023 08:14:36 +0200 Subject: [PATCH 1/3] Elaborated multidisc FAQ with github discussions extlink --- docs/changelog.rst | 3 +++ docs/conf.py | 1 + docs/faq.rst | 10 +++++++++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 05b450019..8b0857e06 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -207,6 +207,9 @@ Other changes: * :doc:`/plugins/lyrics`: Remove Musixmatch from default enabled sources as they are currently blocking requests from the beets user agent. :bug:`4585` +* :doc:`/faq`: :ref:`multidisc`: Elaborated the multi-disc FAQ :discussions:`4806` +* :doc:`/faq`: :ref:`src`: Removed some long lines. +* /conf.py: Added extlink for github discussions. 1.6.0 (November 27, 2021) ------------------------- diff --git a/docs/conf.py b/docs/conf.py index cb7596c55..4f7d6880b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,7 @@ pygments_style = 'sphinx' # External links to the bug tracker and other sites. extlinks = { 'bug': ('https://github.com/beetbox/beets/issues/%s', '#%s'), + 'discussions': ('https://github.com/beetbox/beets/discussions/%s', '#%s'), 'user': ('https://github.com/%s', '%s'), 'pypi': ('https://pypi.org/project/%s/', '%s'), 'stdlib': ('https://docs.python.org/3/library/%s.html', '%s'), diff --git a/docs/faq.rst b/docs/faq.rst index e7f5cc600..6b987dd19 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -59,6 +59,12 @@ with the ``%if{}`` function to accomplish this:: item_fields: multidisc: 1 if disctotal > 1 else 0 +Note that the ``paths`` specification above only contains the +``default`` key and leaves the ``comp`` and ``singleton`` keys to their +default values as documented in :ref:`path-format-config`. The spec above +will therefore not create "Disc N" directories for compilations or singletons +unless you override those respective keys as well. + .. _multidisc: @@ -138,7 +144,9 @@ it's helpful to run on the "bleeding edge". To run the latest source: 2. Install from source. Choose one of these methods: - Directly from GitHub using - ``python -m pip install git+https://github.com/beetbox/beets.git`` command. Depending on your system, you may need to use ``pip3`` and ``python3`` instead of ``pip`` and ``python`` respectively. + ``python -m pip install git+https://github.com/beetbox/beets.git`` + command. Depending on your system, you may need to use ``pip3`` + and ``python3`` instead of ``pip`` and ``python`` respectively. - Use ``pip`` to install the latest snapshot tarball. Type: ``pip install https://github.com/beetbox/beets/tarball/master`` - Grab the source using git. First, clone the repository: From 12db5fc4c98e7f822fd4917136ccaa35183de6ca Mon Sep 17 00:00:00 2001 From: Pieter Lenaerts Date: Sat, 3 Jun 2023 08:20:00 +0200 Subject: [PATCH 2/3] Reverting dicussions extlink Discussions on github can be referenced as issues. The discussions extlink was therefore not needed. --- docs/changelog.rst | 3 +-- docs/conf.py | 1 - 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 8b0857e06..ec86039d7 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -207,9 +207,8 @@ Other changes: * :doc:`/plugins/lyrics`: Remove Musixmatch from default enabled sources as they are currently blocking requests from the beets user agent. :bug:`4585` -* :doc:`/faq`: :ref:`multidisc`: Elaborated the multi-disc FAQ :discussions:`4806` +* :doc:`/faq`: :ref:`multidisc`: Elaborated the multi-disc FAQ :bug:`4806` * :doc:`/faq`: :ref:`src`: Removed some long lines. -* /conf.py: Added extlink for github discussions. 1.6.0 (November 27, 2021) ------------------------- diff --git a/docs/conf.py b/docs/conf.py index 4f7d6880b..cb7596c55 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,6 @@ pygments_style = 'sphinx' # External links to the bug tracker and other sites. extlinks = { 'bug': ('https://github.com/beetbox/beets/issues/%s', '#%s'), - 'discussions': ('https://github.com/beetbox/beets/discussions/%s', '#%s'), 'user': ('https://github.com/%s', '%s'), 'pypi': ('https://pypi.org/project/%s/', '%s'), 'stdlib': ('https://docs.python.org/3/library/%s.html', '%s'), From 0e446fd16aa34f2a3e23b725542d82f741008a30 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sat, 3 Jun 2023 14:59:25 -0700 Subject: [PATCH 3/3] Simplify wording a bit --- docs/faq.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 6b987dd19..814f87b7a 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -59,11 +59,11 @@ with the ``%if{}`` function to accomplish this:: item_fields: multidisc: 1 if disctotal > 1 else 0 -Note that the ``paths`` specification above only contains the -``default`` key and leaves the ``comp`` and ``singleton`` keys to their -default values as documented in :ref:`path-format-config`. The spec above -will therefore not create "Disc N" directories for compilations or singletons -unless you override those respective keys as well. +This ``paths`` configuration only contains the +``default`` key: it leaves the ``comp`` and ``singleton`` keys as their +default values, as documented in :ref:`path-format-config`. +To create "Disc N" directories for compilations and singletons, you will need +to specify similar templates for those keys as well. .. _multidisc: