fontlab python docs

Fontlab 7 Python API -Dokumentation

Anzeigen der Dokumentation

Besuchen Sie die fontlabcom.github.io/fontlab-python-docs, um die Dokumentation im Browser anzuzeigen.

Aufbau der Dokumentation

Installieren Sie Fontlab 7 und Python 2.7, die Fontlab verwendet.

Rennen Sie in Terminal- oder Befehlszeile:

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

Bau der Fontlab 7 Python API -Dokumente

Gehen Sie in den Ordner fontlab7/build .

Öffnen Sie build_fontlab7_api_docs.vfpy in Fontlab 7 und warten Sie, bis die pydocmk2 -Pakete die Markdown -Dateien in den Ordner fontlab7/srcdocs/mkdocs generieren.

In Terminal gehen Sie zum fontlab7/build -Ordner und rennen Sie:

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

oder auf macOS doppelklicken Sie auf build_fontlab7_api_docs.command

Dadurch wird die HTML -Dokumentation mithilfe von mkdocs in den docs/ Ordner erstellt.

Bau des Fontlab 7 Pythonqt API -Dokumente

Gehen Sie in den Ordner pythonqt/build und gehen Sie auf die gleiche Weise. Dies wird in den Ordner docs/pythonqt aufgebaut.

Beitrag zur Dokumentation

Bevor Sie zu diesem Repository beitragen, müssen Sie der LIZENTLIZEIL -Vertrag von Fontlab Individual Contributor zustimmen

Einfach

1. Schauen Sie sich im Ordner srcdocs/mkdocs einen Grundnamen (ohne die .md -Erweiterung) nach.
2. Gehen Sie zum Wiki und erstellen Sie einen neuen Artikel mit demselben Namen.
3. Schreiben Sie Ihren Inhalt - wir werden es überprüfen und in die offiziellen Dokumente weitergeben.

Fortschrittlich

Fork das Repo.

Der fontlab7/srcdocs/ Ordner hat drei Unterordner:

• docs enthält .md -Dateien, die in der Dokumentation als separate Dokumente enthalten sind
• pre kann optionale .md -Dateien enthalten, die die gleichen Namen wie die autogenerierten API -Dokumente haben (z. B. typerig.core.objects.cubicbezier.md
• post kann optionale .md -Dateien enthalten, die die gleichen Namen wie die autogenerierten API -Dokumente haben (z. B. typerig.core.objects.cubicbezier.md ): Der Inhalt jeder solchen Datei wird an die autogenerierte DOC -Datei angehängt (bis zum Ende hinzugefügt)

Sie können neue Dokumente in pre und post erstellen, um den autogenerierten Inhalt mit menschlicher Dokumentation zu verbessern.

Erstellen Sie eine Pull -Anfrage und wir werden es in Betracht ziehen.

Die Datei pydocmk.yml YAML steuert den Build -Prozess. Weitere Informationen finden Sie in PyDocmk2.

Lizenz

Die Dokumentation ist unter der Apache 2 -Lizenz lizenziert. Copyright © 2017-2020 Fontlab Ltd.