Change Log

Hint

You may want to learn about our Release Strategy

Version 2.x

2.5

Date:

📅2025-10-28

Download:

🏷️2.5

• fix: Convert MIDI track name to utf-8 (🚀47)

• ci: No longer need checkout submodules

2.4

Date:

📅2025-10-02

Download:

🏷️2.4

• feat: Support multiple MIDI outputs (🚀45)

• Add confval ⚙️lilypond_include_paths for appending search paths for including LilyPond files (🚀46)

2.3

Date:

📅2025-09-01

Download:

🏷️2.3

• Use jianpu-ly pypi version (🚀39)

• Add 🎵 Jianpu (Change Chords into Roman Numerals)

2.2

Date:

📅2024-03-31

Download:

🏷️2.2

• Fix broken PyPI package

2.1

Date:

📅2024-03-23

Download:

🏷️2.1

• Support 🎵 Playable Inline Score (🚀39)

• Update jianpu-ly submodule to v1.75

• Document improvements

2.0.1

Date:

📅2023-08-19

Download:

🏷️2.0.1

• Compat with Sphinx 7.2’s changes

2.0.0

Date:

📅2023-08-18

Download:

🏷️2.0.0

Warning

This release introduces some BREAKING changes.

• BREAKING changes:

  • Drop :noheader, :nofooter: options. User should modifying their Lilypond

    source to removing header and footer of scores, see Custom titles headers and footers

    for more details (💬35)

  • Drop :noedge: option and introduce :nocrop: with opposite meaning compared to before.

    It is said that score is croppped (noedge) by default

    By the way, dependencies to Wand and ImageMagick are dropped (💬31)

  • Drop :audio: option and introduce :noaudio: with opposite meaning compared to before.

    Audio will be auto-generated when any MIDI output avaliable, and user set :noaudio:

    only when they don’t need this behavior (🚀36)

• Enhanced Jianpu support (💬30)

  • Don’t panic when Jianpu parsing failed

  • Can display multiple Jianpu scores, see also jianpu-ly#35

  • Audio works fine now

• Score image generataion is reproducible now (💬10)

Version 1.x

1.6.1

Date:

📅2023-06-09

Download:

🏷️1.6.1

• Support including score from abs path (🚀25)

1.6.0

Date:

📅2022-10-08

Download:

🏷️1.6.0

• Fix resolution of SVG output (🚀18)

• Add basic Jianpu (Numbered Musical Notation) support (💬17)

• Don’t panic when running unsupported builders (💬20)

1.5

Date:

📅2022-03-13

Download:

🏷️1.5

• Add LaTeX builder suppport (💬11)

1.4

Date:

📅2021-12-19

Download:

🏷️1.4

• Note ly files as dependencies, so Sphinx will rebuild document when ly file changes

• Won’t crash when score file does not exist

• Left a “system message” paragraphs when score build failed

• Add support for MP3 audio format, FFmpeg is required

1.3

Date:

📅2021-11-07

Download:

🏷️1.3

• Add controls flag for specifing the position of the control bar

1.2

Date:

📅2021-09-17

Download:

🏷️1.2

• Simplify argument passing between lilypond binding and sphinx extension

• Add loop flag for directives

• Add confval ⚙️lilypond_audio_volume

1.1

Date:

📅2021-09-12

Download:

🏷️1.1

• Add confval ⚙️lilypond_png_resolution for customizing score resolution in PNG format

• Add confval ⚙️lilypond_inline_score_size for customizing height of inline score

• Stop using <figure> as container of block-level score, which is buggy on Safari

1.0

Date:

📅2021-06-26

Download:

🏷️1.0

• Rebuild env when configuration changed

• Fix wrong license value

Pre-release

1.0a2

Date:

📅2020-12-27

Download:

🏷️1.0a2

• Support multiple pages documents

• Imporve of lilypond outputs cache

1.0a1

Date:

📅2020-12-26

Download:

🏷️1.0a1

• Fix invalid insertion of \header

• Set default audio format to wav

1.0a0

Date:

📅2020-12-06

Download:

🏷️1.0a0

The alpha version is out, enjoy~