fontlab python docs

Fontlab 7 Python API Documentation

Ver la documentación

Visite el fontlabcom.github.io/fontlab-python-docs para ver la documentación en el navegador.

Construyendo la documentación

Instale FontLab 7 y Python 2.7 que usa FontLab.

En terminal o línea de comandos, ejecute:

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

Construyendo los documentos de la API de FontLab 7 Python

Vaya a la carpeta fontlab7/build .

Abra build_fontlab7_api_docs.vfpy en FontLab 7 y espere hasta que los paquetes pydocmk2 generen los archivos de Markdown en la carpeta fontlab7/srcdocs/mkdocs .

En la terminal, vaya a la carpeta fontlab7/build y ejecute:

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

O, en macOS, haga doble clic en build_fontlab7_api_docs.command

Esto construirá la documentación HTML utilizando mkdocs en la carpeta docs/ .

Construyendo los documentos de la API de FontLab 7 Pythonqt

Vaya a la carpeta pythonqt/build y continúe de la misma manera. Esto se convertirá en la carpeta docs/pythonqt .

Contribuyendo a la documentación

Antes de contribuir a este repositorio, debe aceptar el acuerdo de licencia de contribuyente individual de FontLAB

Simple

1. Busque un nombre base (sin la extensión .md ) en la carpeta srcdocs/mkdocs .
2. Vaya al wiki y cree un nuevo artículo con el mismo nombre.
3. Escriba su contenido: lo revisaremos y lo moveremos a los documentos oficiales.

Avanzado

Bifurca el repositorio.

La carpeta fontlab7/srcdocs/ tiene tres subcarpetas:

• docs contiene archivos .md que se incluirán en la documentación como documentos separados
• pre puede contener archivos .md opcionales que tienen los mismos nombres que los documentos API autogenerados (por ejemplo, typerig.core.objects.cubicbezier.md ): el contenido de cada archivo se prependrá al archivo DOC autogenerado (insertado después del primer encabezado)
• post puede contener archivos .md opcionales que tienen los mismos nombres que los documentos API autogenerados (por ejemplo, typerig.core.objects.cubicbezier.md ): el contenido de cada archivo se agregará al archivo DOC autogenerado (agregado al final)

Puede crear nuevos documentos en las carpetas pre y post para mejorar el contenido autogenerado con la documentación autorizada por los humanos.

Cree una solicitud de extracción y la consideraremos.

El archivo pydocmk.yml YAML controla el proceso de compilación, consulte PYDOCMK2 para más detalles.

Licencia

La documentación tiene licencia bajo la licencia Apache 2. Copyright © 2017-2020 FontLab Ltd.