Configuration¶

Hint

In most cases, the extension should work without any configuration.

lilypond_lilypond_args¶

Type:: list
Default:: ['lilypond']

Argument list for running LilyPond. The first one is path to LilyPond binary.

Added in version 1.4.

lilypond_timidity_args¶

Type:: list
Default:: ['timidity']

Argument list for running Timidity++. The first one is path to Timidity++ binary.

lilypond_ffmpeg_args¶

Type:: list
Default:: ['ffmpeg']

Argument list for running FFmpeg. The first one is path to FFmpeg binary.

lilypond_score_format¶

Type:: str
Default:: 'png'

choice:: ‘png’ ‘svg’ ‘pdf’ ‘eps’

Format of outputed scores.

lilypond_audio_format¶

Type:: str
Default:: 'wav'

Format of outputed audio, available values: [‘wav’, ‘ogg’, ‘mp3’]

Changed in version 1.4: Add support for ‘mp3’ audio format

lilypond_audio_volume¶

Type:: float
Default:: None

Volume of outputed audio, will be converted to value of Timidity++ argument --volume.

Added in version 1.2.

lilypond_png_resolution¶

Type:: int
Default:: 300

Resolution in DPI of score in PNG format, will be converted to value of LilyPond argument -dresolution.

Added in version 1.1.

lilypond_inline_score_size¶

Type:: str
Default:: '2.5em'

Line height of inline socre, will be converted to value of CSS height.

Added in version 1.1.

lilypond_include_paths¶

Type:: list
Default:: []

A list of paths relative to Sphinx source directory. It is used as additional search path for Including LilyPond files, will be converted to value of LilyPond argument -I/--include.

For example, set lilypond_include_paths to /_scores:

Include another file¶

Source

.. lily::

   \version "2.24.0"

   \include "include.ly"

   \score {
     \new Staff { \myMusic }
   }

Result

$\version "2.24.0" \include "include.ly" \score { \new Staff { \myMusic } }$

/_scores/include.ly¶

myMusic = { c' d' e' f' }

Added in version 2.4.