sphinxcontrib-lilypond


Namesphinxcontrib-lilypond JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/FabriceSalvaire/sphinx-lilypond
SummarySphinx lilypond extension
upload_time
maintainer
docs_urlNone
authorFabrice Salvaire
requires_python
licenseBSD
keywords sphinx extension literalinclude
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. |Pypi Version| image:: https://img.shields.io/pypi/v/sphinxcontrib-lilypond.svg
   :target: https://pypi.python.org/pypi/sphinxcontrib-lilypond
   :alt: sphinxcontrib-lilypond last version

.. |Pypi License| image:: https://img.shields.io/pypi/l/sphinxcontrib-lilypond.svg
   :target: https://pypi.python.org/pypi/sphinxcontrib-lilypond
   :alt: sphinxcontrib-lilypond license

.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-lilypond.svg
   :target: https://pypi.python.org/pypi/sphinxcontrib-lilypond
   :alt: sphinxcontrib-lilypond python version

.. |Python| replace:: Python
.. _Python: http://python.org

.. |PyPI| replace:: PyPI
.. _PyPI: https://pypi.python.org/pypi

.. |Sphinx| replace:: Sphinx
.. _Sphinx: http://sphinx-doc.org

==============================
 Lilypond plugin for Sphinx
==============================

|Pypi License|
|Pypi Python Version|

|Pypi Version|

This plugin implements a ``lily`` role and directive to include Music score formatted by `Lilypond
<http://lilypond.org>`_.

Changelog
---------

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

Credits
-------

* `Fabrice Salvaire <http://fabrice-salvaire.fr>`_ 2017
* Wei-Wei Guo 2009, licensed under BSD https://bitbucket.org/birkenfeld/sphinx-contrib

Installation
------------

Using ``pip``:

.. code-block:: bash

    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 = []



            

Raw data

            {
    "_id": null,
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "cheesecake_code_kwalitee_id": null,
    "keywords": "sphinx extension literalinclude",
    "author": "Fabrice Salvaire",
    "home_page": "https://github.com/FabriceSalvaire/sphinx-lilypond",
    "github_user": "FabriceSalvaire",
    "download_url": "http://pypi.python.org/pypi/sphinxcontrib-lilypond",
    "platform": "any",
    "version": "1.1.0",
    "cheesecake_documentation_id": null,
    "description": ".. |Pypi Version| image:: https://img.shields.io/pypi/v/sphinxcontrib-lilypond.svg\n   :target: https://pypi.python.org/pypi/sphinxcontrib-lilypond\n   :alt: sphinxcontrib-lilypond last version\n\n.. |Pypi License| image:: https://img.shields.io/pypi/l/sphinxcontrib-lilypond.svg\n   :target: https://pypi.python.org/pypi/sphinxcontrib-lilypond\n   :alt: sphinxcontrib-lilypond license\n\n.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-lilypond.svg\n   :target: https://pypi.python.org/pypi/sphinxcontrib-lilypond\n   :alt: sphinxcontrib-lilypond python version\n\n.. |Python| replace:: Python\n.. _Python: http://python.org\n\n.. |PyPI| replace:: PyPI\n.. _PyPI: https://pypi.python.org/pypi\n\n.. |Sphinx| replace:: Sphinx\n.. _Sphinx: http://sphinx-doc.org\n\n==============================\n Lilypond plugin for Sphinx\n==============================\n\n|Pypi License|\n|Pypi Python Version|\n\n|Pypi Version|\n\nThis plugin implements a ``lily`` role and directive to include Music score formatted by `Lilypond\n<http://lilypond.org>`_.\n\nChangelog\n---------\n\n* 2017-xx SVG format is waiting a cropping solution\n* 2017-11 Cleanup for Python 3\n\nCredits\n-------\n\n* `Fabrice Salvaire <http://fabrice-salvaire.fr>`_ 2017\n* Wei-Wei Guo 2009, licensed under BSD https://bitbucket.org/birkenfeld/sphinx-contrib\n\nInstallation\n------------\n\nUsing ``pip``:\n\n.. code-block:: bash\n\n    pip install sphinxcontrib-lilypond\n\nFunctionalities\n---------------\n\n- A ``lily`` role to include a standalone music markup.\n  For example, a G clef can be inserted by::\n\n     :lily:`\\musicglyph #\"clefs.G\"`\n\n  The purpose of the 'lily' role is writing music comments or learning notes.\n  So only one markup is allowed.\n\n- A ``lily`` directive to include a score, for example::\n\n     .. lily::\n\n        \\relative c'' {\n          c4 a d c\n        }\n\nSettings\n--------\n\nThe ``lilypond_fontsize`` variable can be used to set the font size::\n\n     lilypond_fontsize = [6, -3]\n\n* The first value is for ``lily`` role setting in absolute font size.\n* The second value is for ``lily`` directive setting in relative font size.\n\nDefault settings::\n\n    lilypond_preamble = ''\n    lilypond_fontsize = [10, -3]\n    lilypond_command = 'lilypond'\n    lilypond_args = []\n\n\n",
    "lcname": "sphinxcontrib-lilypond",
    "name": "sphinxcontrib-lilypond",
    "github": true,
    "coveralls": false,
    "bugtrack_url": null,
    "license": "BSD",
    "travis_ci": false,
    "github_project": "sphinx-lilypond",
    "summary": "Sphinx lilypond extension",
    "split_keywords": [
        "sphinx",
        "extension",
        "literalinclude"
    ],
    "author_email": "fabrice.salvaire@orange.fr",
    "urls": [],
    "cheesecake_installability_id": null
}
        
Elapsed time: 0.05764s