sphinxnotes-lilypond#

Sphinx extension for embedding LilyPond scores.

Documentation: https://sphinx.silverrainz.me/lilypond
Source: https://github.com/sphinx-notes/lilypond
Changelog: https://sphinx.silverrainz.me/lilypond/changelog.html
Tracker: https://github.com/sphinx-notes/lilypond/issues
Download: https://pypi.org/project/sphinxnotes-lilypond/#files

Introduction#

The extension is originated from sphinx-contrib/lilypond , allows LilyPond music notes $\score{\relative { c' }}$ to be included in Sphinx-generated documents. Compared to its predecessor, the extension has many new features such as:

Play score audio (Examples)
LaTeX builder support (Since 🏷️1.5)
Scale 🎵 Transposing
Jianpu (Numbered Musical Notation, 简谱) support (Since 🏷️1.6.0)
And so on…

Getting Started#

Note

We assume you already have a Sphinx documentation, if not, see Getting Started with Sphinx.

First, downloading extension from PyPI:

$ pip install sphinxnotes-lilypond

Then, add the extension name to extensions configuration item in your conf.py:

extensions = [
          # …
          'sphinxnotes.lilypond',
          # …
          ]

Install the follwing runtime dependencies before using the extension:

Note

A basic understanding of Lilypond notation is required, or you can refer to LilyPond Learning Manual.

We provide Roles for embedding score fragment and Directives for embedding a whole socre:

Result

$\score{\relative { c' }}$ is the first note of the C major scale.

reStructuredText

:lily:`\relative { c' }` is the first note of the C major scale.

Result

$\version "2.20.0" \header { title = "C Major Scale" } \score { << \new Staff { \time 4/4 \tempo 4 = 70 c' d' e' f' g' a' b' c'' } >> \midi {} \layout {} }$

reStructuredText

.. lily::

   \version "2.20.0"
   \header {
     title = "C Major Scale"
   }

   \score {
     <<
       \new Staff {
           \time 4/4
           \tempo 4 = 70
           c' d' e' f' g' a' b' c''
     }
     >>

     \midi {}
     \layout {}
   }

See Usage for more details.

Contents#

The Sphinx Notes Project#

+The project is developed by Shengyu Zhang, as part of The Sphinx Notes Project.

The Sphinx Notes Project