sphinx-contrib-pygtk / lilypond /

Filename Size Date modified Message
..
sphinxcontrib
49 B
1.1 KB
81 B
1.1 KB
.. -*- restructuredtext -*-

=============================
README for Lilypond Extension
=============================

It's a extension for including Lilypond music notes. The extension is made 
by modifying mathbase.py and pngmath.py. Most codes are copied and pasted
with some tiny changes. 


Functionalities
===============

- A new role 'lily'. the 'lily' role can input 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 new directive 'lily'. The 'lily' directive can input a piece of music
  script, for example, ::

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


Installing
==========

- A new config 'pnglily_fontsize', which can be used to set fontsize of
  'lily' role and 'lily' directive. ::

     pnglily_fontsize = ['6', '-3']

  The first value is for 'lily' role setting in absolute fontsize. The
  second value is for 'lily' directive setting in relative fontsize. 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.