{
    "info": {
        "author": "Matteo Ceccarello",
        "author_email": "matteo.ceccarello@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5"
        ],
        "description": "Lydoc - A Lilypond API documentation generator\n##############################################\n\n.. image:: https://img.shields.io/pypi/v/lydoc.svg?maxAge=2592000   \n   :target: https://pypi.python.org/pypi/lydoc\n   :alt: PyPI Package\n.. image:: http://readthedocs.org/projects/lydoc/badge/?version=latest\n   :target: http://lydoc.readthedocs.io/en/latest/?badge=latest\n   :alt: Documentation Status\n.. image:: https://travis-ci.org/Cecca/lydoc.svg?branch=master\n   :target: https://travis-ci.org/Cecca/lydoc\n   :alt: Continuous Integration\n\n..\n   The marker below is used to tell Sphinx where to start\n   to include the README file into the main documentation\n\n.. inclusion-marker\n\nLydoc is a software that looks for documentation comments in `GNU\nLilypond`_ source files, and outputs API documentation in a variety of\nformats.\n\n-----------------------------------------------------------------------\n\nInstallation\n============\n\nLydoc works with both Python 2 (version 2.7 is supported) and Python 3\n(versions 3.3, 3.4, and 3.5). You can install it in several ways.\n\n>From source\n-----------\n\nClone the repository somewhere on your machine. To install, run from\nthe root directory of the project::\n\n  python setup.py install\n\nwhich will install the ``lydoc`` executable, while fetching all the\nnecessary dependencies in the process. To upgrade, just pull the\nlatest changes and run the above command again.\n\n>From PyPI\n---------\n\nLydoc is also available on the Python Package Index. You can install\nit with this single command::\n\n  pip install --user lydoc\n\nI recommend running the above command with the ``--user`` option so\nnot to mess with system packages. If you omit the ``--user`` argument,\nyou might require administration privileges, depending on you\nmachine's configuration.\n\nTo upgrade, it is sufficient to run the following command::\n\n  pip install --user --upgrade lydoc\n\nVery quick start\n================\n\nJust run the following command::\n\n  lydoc -o api.rst file.ly\n\nto collect documentation from ``file.ly`` and write a ``api.rst`` text\nfile formatted with `reStructuredText`_.\n\nQuick start\n===========\n\nLydoc will look for documentation comments in the given file or\ndirectory. In the latter case, it will parse all ``.ly`` and ``.ily``\nfiles, recursively. A documentation comment looks like a standard\nLilypond block comment, with a slightly different opening::\n\n  %{!\n  % I am a documentation comment :-)\n  %}\n  someFunction =\n  #(define-music-function ...)\n\nNote the ``!`` character after the opening of the comment: that's the\ncharacter that Lydoc uses to distinguish between normal block comments\nand documentation ones.\n\nSo, to extract the documentation from a single file, the command line\nis the following::\n\n  lydoc file.ly\n\nThis will output some logging information to standard error, and the\ncollected documentation on standard output, as a stream of JSON\nobjects, one per line. This is useful to pipe the output of Lydoc to\nsome other program, in a machine-friendly format.\n\nHowever, we are humans, not machines, hence we might want to generate\nsomething more readable, like a file in some lightweight markup\nlanguage. You have some options:\n\n`Markdown`_\n  Arguably the most widespread lightweight markup language::\n\n    lydoc -o api.md file.ly\n\n`reStructuredText`_\n  The markup language used by the powerful `Sphinx`_\n  documentation generator::\n\n    lydoc -o api.rst file.ly\n\n\nTo generate API documentation for a single lilypond file in\n`reStructuredText`_ format::\n\n    lydoc -o api.rst file.ly\n\nor in `Markdown`_::\n\n    lydoc -o api.md file.ly\n\n\nFor more detailed usage instructions, head to the :doc:`/user-manual`\npage.\n\n\n.. _`GNU Lilypond`: http://lilypond.org/\n.. _reStructuredText: http://www.sphinx-doc.org/en/stable/rest.html\n.. _Markdown: http://daringfireball.net/projects/markdown/\n.. _Sphinx: http://www.sphinx-doc.org/en/stable/index.html",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/Cecca/lydoc",
        "keywords": "",
        "license": "GPLv3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "lydoc",
        "package_url": "https://pypi.org/project/lydoc/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/lydoc/",
        "project_urls": {
            "Homepage": "https://github.com/Cecca/lydoc"
        },
        "release_url": "https://pypi.org/project/lydoc/0.1.1/",
        "requires_dist": [
            "grako",
            "jinja2",
            "pyinstaller; extra == 'dev'",
            "coverage; extra == 'test'",
            "nose; extra == 'test'"
        ],
        "requires_python": "",
        "summary": "An API documentation generator for Lilypond files",
        "version": "0.1.1"
    },
    "last_serial": 2091856,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b4a4f93796307bacc0ab5a20011a0f7a",
                    "sha256": "9863673e45f124f50c5c3bf41796eb70db608aa39f7071e53abafccf1c48d918"
                },
                "downloads": -1,
                "filename": "lydoc-0.1.0-py2.py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "b4a4f93796307bacc0ab5a20011a0f7a",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 12883,
                "upload_time": "2016-04-30T02:12:37",
                "url": "https://files.pythonhosted.org/packages/41/66/f62dbb253f17b6f3a5f865f0f5e9e107a8c67e98344adfb81e632bfc9d9d/lydoc-0.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "0d4bd6bb39443c87bdba92f5a982764f",
                    "sha256": "1f2321a546b6a2033547d7430950aa4be0b27a22e7b74253f98322c082b7c352"
                },
                "downloads": -1,
                "filename": "lydoc-0.1.0.tar.gz",
                "has_sig": true,
                "md5_digest": "0d4bd6bb39443c87bdba92f5a982764f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21984,
                "upload_time": "2016-04-30T02:12:44",
                "url": "https://files.pythonhosted.org/packages/0e/7a/bb374cf26c2756b4ea0d8580991ea01bd05e608519b958efc4b1a354718e/lydoc-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f6d6e74c86c83a209cbc5f1eb87e0bc0",
                    "sha256": "571fbfe6df9548317ad42b14ad850b4f4c708659d2b6f218ca951fc4005e2cb7"
                },
                "downloads": -1,
                "filename": "lydoc-0.1.1-py2.py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "f6d6e74c86c83a209cbc5f1eb87e0bc0",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 14042,
                "upload_time": "2016-04-30T02:36:29",
                "url": "https://files.pythonhosted.org/packages/af/65/49464c73f18a51c0d07cef18c498e2a907b895be62ce55297fdf2bd83454/lydoc-0.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2c706176b1bc6dfa7747bd2129d127b2",
                    "sha256": "b20ed39c7f06c3278372f06012c7c95df11592cce851cb555702c0a5899c4c72"
                },
                "downloads": -1,
                "filename": "lydoc-0.1.1.tar.gz",
                "has_sig": true,
                "md5_digest": "2c706176b1bc6dfa7747bd2129d127b2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 22791,
                "upload_time": "2016-04-30T02:36:35",
                "url": "https://files.pythonhosted.org/packages/7f/b2/774cab34795868241df9a7bbf20c74ab42c49bb99c4c0c50719eeadbf885/lydoc-0.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f6d6e74c86c83a209cbc5f1eb87e0bc0",
                "sha256": "571fbfe6df9548317ad42b14ad850b4f4c708659d2b6f218ca951fc4005e2cb7"
            },
            "downloads": -1,
            "filename": "lydoc-0.1.1-py2.py3-none-any.whl",
            "has_sig": true,
            "md5_digest": "f6d6e74c86c83a209cbc5f1eb87e0bc0",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 14042,
            "upload_time": "2016-04-30T02:36:29",
            "url": "https://files.pythonhosted.org/packages/af/65/49464c73f18a51c0d07cef18c498e2a907b895be62ce55297fdf2bd83454/lydoc-0.1.1-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "2c706176b1bc6dfa7747bd2129d127b2",
                "sha256": "b20ed39c7f06c3278372f06012c7c95df11592cce851cb555702c0a5899c4c72"
            },
            "downloads": -1,
            "filename": "lydoc-0.1.1.tar.gz",
            "has_sig": true,
            "md5_digest": "2c706176b1bc6dfa7747bd2129d127b2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 22791,
            "upload_time": "2016-04-30T02:36:35",
            "url": "https://files.pythonhosted.org/packages/7f/b2/774cab34795868241df9a7bbf20c74ab42c49bb99c4c0c50719eeadbf885/lydoc-0.1.1.tar.gz"
        }
    ]
}