lilypond文件的api文档生成器

lydoc的Python项目详细描述


Lydoc - A Lilypond API documentation generator
##############################################

.. 图片::https://img.shields.io/pypi/v/lydoc.svg?maxage=2592000
:目标:https://pypi.python.org/pypi/lydoc
:alt:pypi package
…图片:http://readthedocs.org/projects/lydoc/badge/?version=latest
:目标:http://lydoc.readthedocs.io/en/latest/?徽章=最新
:alt:文档状态
…图片:https://travis-ci.org/cecca/lydoc.svg?branch=master
:target:https://travis ci.org/cecca/lydoc
:alt:continuous integration

……
下面的标记用于告诉sphinx从哪里开始
将自述文件包含到主文档中

。包含标记

lydoc是一个软件,它查找“gnu
lilypond”源文件中的文档注释,并以各种
格式输出api文档。

支持2.7)和python 3
(版本3.3、3.4和3.5)。您可以通过多种方式安装它。

>;从源代码中复制存储库。要安装,请从项目的根目录运行:


python setup.py install

,它将安装“lydoc”可执行文件,同时获取进程中所有必需的依赖项。若要升级,只需拉动
最新更改并再次运行上述命令即可。python包索引中也提供了来自pypi的
-

::

pip install--user lydoc

如果省略`--user``参数,
可能需要管理权限,具体取决于计算机的配置。

运行以下命令就足够了:



very quick start
===


` structuredText`.


快速启动
==


目录中查找文档注释。在后一种情况下,它将递归地解析所有`.ly``和`.ly`
文件。文档注释看起来像标准的lilypond块注释,其开头稍有不同:

%{!
%i是一个文档注释:-)
%}
somefunction=
(定义音乐函数…

``注释打开后的字符:这是lydoc用来区分普通块注释和文档注释的字符。命令行
如下::


这有助于将lydoc的输出以机器友好的格式传送到其他程序。

您可以选择:

`markdown`\br/>可以说是最广泛使用的轻量级标记语言:


`structuredtext`\ubr/>强大的“sphinx”文档生成器使用的标记语言



一个lilypond文件,格式为:lydoc-o api。RST文件。ly

或在“markdown”中:




有关更详细的使用说明,请转到:doc:`/用户手册`
页。



_` gnu lilypond`:http://lilypond.org/
。_重构文本:http://www.sphinx-doc.org/en/stable/rest.html
…_降价:http://daringfireball.net/projects/markdown/
。_斯芬克斯:http://www.sphinx-doc.org/en/stable/index.html

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java出现编译错误,我不理解   java在gnu-trove库中是否有任何有序映射?   java Servlet应该有映射,但找不到Servlet   java时间和第二期显示1:10,而不是13:10   java Play Framework 1.2.7 Heroku更新崩溃   线程“main”java中的opencsv异常。lang.NoClassDefFoundError:org/apache/commons/lang3/ObjectUtils   selenium在java中隐藏警告消息   java使用ID引用将JSON实体反序列化为POJO   java无法在JRE 8中加载字体   一个线程中的异常/错误会使整个应用程序停止吗?   java访问重复子规则的元素标签;e、 g.用ANTLR解析(1,2,3)中的a   java如何从平移旋转中找到新坐标   使用HTML Java小程序托管jar文件存在安全问题   java如何按频率而不是字母顺序排列字符串数组   java清除bufferedReader和块以获得更多输入   java解密SAML2断言