Giter Club home page Giter Club logo

sphinx-lilypond's Introduction

Lilypond plugin for Sphinx

sphinxcontrib-lilypond license sphinxcontrib-lilypond python version

sphinxcontrib-lilypond last version

This plugin implements a lily role and directive to include Music score formatted by Lilypond.

Changelog

  • 2017-xx SVG format is waiting a cropping solution
  • 2017-11 Cleanup for Python 3

Credits

Installation

Using pip:

pip install sphinxcontrib-lilypond

Functionalities

  • A lily role to include a standalone music markup. For example, a G clef can be inserted by:

    :lily:`\musicglyph #"clefs.G"`

    The purpose of the 'lily' role is writing music comments or learning notes. So only one markup is allowed.

  • A lily directive to include a score, for example:

    .. lily::
    
       \relative c'' {
         c4 a d c
       }

Settings

The lilypond_fontsize variable can be used to set the font size:

lilypond_fontsize = [6, -3]
  • The first value is for lily role setting in absolute font size.
  • The second value is for lily directive setting in relative font size.

Default settings:

lilypond_preamble = ''
lilypond_fontsize = [10, -3]
lilypond_command = 'lilypond'
lilypond_args = []

sphinx-lilypond's People

Contributors

fabricesalvaire avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.