beets/docs
Noor ac96b9b64e
Preserve line breaks for example cases in substitution plugin docs (#5846)
## Description

Adds line block markup to example substitutions in the plugin
documentation, so that each case is shown on a separate line:

> The replacement can be an expression utilising the matched regex,
allowing us to create more general rules. Say for example, we want to
sort all albums by multiple artists into the directory of the first
artist. We can thus capture everything before the first ,, `` &`` or ``
and``, and use this capture group in the output, discarding the rest of
the string.
> 
> ```yaml
> substitute:
>  ^(.*?)(,| &| and).*: \1
> ```
>
> This would handle all the below cases in a single rule:
>
>> Bob Dylan and The Band -> Bob Dylan
>> Neil Young & Crazy Horse -> Neil Young
>> James Yorkston, Nina Persson & The Second Hand Orchestra -> James
Yorkston
2025-07-02 18:40:37 +00:00
..
_static Transparent background logo for docs 2023-10-29 10:30:33 +01:00
_templates/autosummary Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
api Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
dev Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
guides Fix Broken link for Arch Linux package 2025-04-08 15:33:43 +02:00
plugins Preserve line breaks for example cases in substitution plugin docs (#5846) 2025-07-02 18:40:37 +00:00
reference Add changelog note about musicbrainz 2025-05-17 03:32:00 +01:00
.gitignore Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
changelog.rst Preserve line breaks for example cases in substitution plugin docs (#5846) 2025-07-02 18:40:37 +00:00
code_of_conduct.rst Integrate code of conduct 2023-10-27 21:55:13 +10:00
conf.py Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
contributing.rst add CONTRIBUTING.rst to the docs 2020-07-20 19:56:05 -07:00
faq.rst Link to specific bug report/feature request templates in docs 2025-02-16 23:41:00 +00:00
index.rst Integrate code of conduct 2023-10-27 21:55:13 +10:00
Makefile Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
modd.conf Switch to modd for live docs build 2017-12-21 11:39:08 -05:00
team.rst [docs/team] Add '@bal-e' 2024-07-31 23:24:18 +02:00