fontlab python docs

Fontlab 7 Python API文档

查看文档

请访问fontlabcom.github.io/fontlab-python-docs，以查看浏览器中的文档。

构建文档

安装Fontlab使用的Fontlab 7和Python 2.7。

在终端或命令行中，运行：

 python2 -m pip install --user --upgrade git+https://github.com/twardoch/pydocmk2

构建Fontlab 7 Python API文档

转到fontlab7/build文件夹。

在Fontlab 7中打开build_fontlab7_api_docs.vfpy ，然后等到pydocmk2软件包将标记文件生成fontlab7/srcdocs/mkdocs文件夹。

在终端中，转到fontlab7/build文件夹并运行：

 python2 -m mkdocs build -v -f ../mkdocs.yml --dirty

或者，在macOS上，双击build_fontlab7_api_docs.command

这将在docs/文件夹中使用mkdocs构建HTML文档。

构建Fontlab 7 Pythonqt API文档

转到pythonqt/build文件夹，然后以相同的方式进行。这将构建到docs/pythonqt文件夹中。

为文档做出贡献

在为此存储库做出贡献之前，您必须同意Fontlab个人贡献者许可协议

简单的

1. 在srcdocs/mkdocs文件夹中查找基本名称（无需.md扩展名）。
2. 转到Wiki，创建一个具有相同名称的新文章。
3. 编写您的内容 - 我们将对其进行审查，并将其移至官方文档。

先进的

分叉存储库。

fontlab7/srcdocs/文件夹具有三个子文件夹：

• docs包含将包含在文档中的.md文件作为单独的文档
• pre可能包含具有与自动化API文档相同名称的可选.md文件（例如typerig.core.objects.cubicbezier.md ）：每个此类文件的内容将预先添加到自动化文档文件（插入第一个标头后插入）
• post可能包含具有与自动化API文档相同名称的可选.md文件（例如typerig.core.objects.cubicbezier.md ）：每个此类文件的内容将附加到自动化文档文件（添加到末尾）

您可以在pre和post文件夹中创建新文档，以使用人为实现的文档来增强自动化内容。

创建拉动请求，我们将考虑。

pydocmk.yml yaml文件控制构建过程，有关详细信息，请参见Pydocmk2。

执照

该文档是根据Apache 2许可证获得许可的。版权所有©2017-2020 Fontlab Ltd.