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.