fontlab python docs

Fontlab 7 Python API Documentation

Affichage de la documentation

Visitez le fontlabcom.github.io/fontlab-python-doc pour afficher la documentation du navigateur.

Construire la documentation

Installez Fontlab 7 et Python 2.7 que Fontlab utilise.

En ligne de terminal ou de commande, exécutez:

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

Construire les documents API Fontlab 7 Python

Accédez au dossier fontlab7/build .

Ouvrez build_fontlab7_api_docs.vfpy dans FontLab 7 et attendez que les packages pydocmk2 génèrent les fichiers de marque dans le dossier fontlab7/srcdocs/mkdocs .

Dans Terminal, allez pour aller dans le dossier fontlab7/build et exécuter:

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

Ou, sur macOS, double-cliquez sur build_fontlab7_api_docs.command

Cela créera la documentation HTML à l'aide mkdocs dans le dossier docs/ .

Construire les documents API Fontlab 7 Pythonqt

Accédez au dossier pythonqt/build et procédez de la même manière. Cela s'accumulera dans le dossier docs/pythonqt .

Contribuant à la documentation

Avant de contribuer à ce référentiel, vous devez accepter le contrat de licence de contributeur individuel Fontlab

Simple

1. Recherchez un nom de base (sans l'extension .md ) dans le dossier srcdocs/mkdocs .
2. Allez au wiki et créez un nouvel article avec le même nom.
3. Écrivez votre contenu - nous le consulterons et le déplacerons vers les documents officiels.

Avancé

Fourk le repo.

Le dossier fontlab7/srcdocs/ a trois sous-dossiers:

• docs contient des fichiers .md qui seront inclus dans la documentation en tant que documents distincts
• pre peut contenir des fichiers .md facultatifs qui ont les mêmes noms que les documents API AutoGenerated (par exemple, typerig.core.objects.cubicbezier.md ): le contenu de chaque fichier sera apparenté dans le fichier DOCARITED AUTOGENET (inséré après le premier en-tête)
• post peut contenir des fichiers .md facultatifs qui ont les mêmes noms que les documents API AutoGenerated (par exemple, typerig.core.objects.cubicbezier.md ): le contenu de chaque fichier sera annexé au fichier DOCAnerated Doc (ajouté à la fin)

Vous pouvez créer de nouveaux documents dans des dossiers pre et post pour améliorer le contenu autoogénéré avec une documentation automatisée par l'homme.

Créez une demande de traction et nous le considérerons.

Le fichier pydocmk.yml YAML contrôle le processus de construction, voir PYDOCMK2 pour plus de détails.

Licence

La documentation est autorisée sous la licence Apache 2. Copyright © 2017-2020 Fontlab Ltd.