fontlab python docs

fontlab 7 python apiドキュメント

ドキュメントの表示

fontlabcom.github.io/fontlab-python-docsにアクセスして、ブラウザのドキュメントを表示します。

ドキュメントの構築

FontLab 7とPython 2.7を使用するPython 2.7をインストールします。

ターミナルまたはコマンドラインで、実行してください：

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

fontlab 7 python apiドキュメントの構築

fontlab7/buildフォルダーに移動します。

fontlab 7のOpen build_fontlab7_api_docs.vfpy fontlab 7で、 pydocmk2パッケージがfontlab7/srcdocs/mkdocsフォルダーにマークダウンファイルを生成するまで待ちます。

ターミナルで、 fontlab7/buildフォルダーに移動して実行します。

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

または、macosでは、 build_fontlab7_api_docs.commandダブルクリックします

これにより、 mkdocsを使用してdocs/ FolderにHTMLドキュメントが作成されます。

fontlab 7 pythonqt api docsの構築

pythonqt/buildフォルダーに移動し、同じように進みます。これによりdocs/pythonqtフォルダーに組み込まれます。

ドキュメントに貢献します

このリポジトリに貢献する前に、fontlab個人貢献者ライセンス契約に同意する必要があります

単純

1. srcdocs/mkdocsフォルダーのベース名（ .md拡張機能なし）を検索します。
2. Wikiに移動して、同じ名前の新しい記事を作成します。
3. コンテンツを書く - 私たちはそれをレビューして公式のドキュメントに移動します。

高度な

レポをフォークします。

fontlab7/srcdocs/ folderには3つのサブフォルダーがあります。

• docs 、個別のドキュメントとしてドキュメントに含まれる.mdファイルが含まれています
• pre 、自動生成されたAPIドキュメント（ typerig.core.objects.cubicbezier.mdなど）と同じ名前を持つオプションの.mdファイルが含まれている場合があります。各ファイルのコンテンツは、自動生成ドキュメントファイル（最初のヘッダーの後に挿入された）に加えられます。
• post 、自動生成されたAPIドキュメント（ typerig.core.objects.cubicbezier.mdなど）と同じ名前を持つオプションの.mdファイルが含まれている場合があります。そのような各ファイルのコンテンツは、自動生成ドキュメントファイルに追加されます（最後に追加）

preとpostフォルダーに新しいドキュメントを作成して、人間が執筆したドキュメントを使用して自動生成コンテンツを強化できます。

プルリクエストを作成すると、検討します。

pydocmk.yml yamlファイルはビルドプロセスを制御します。詳細については、pydocmk2を参照してください。

ライセンス

ドキュメントは、Apache 2ライセンスの下でライセンスされています。 Copyright©2017-2020 Fontlab Ltd.