fontlab python docs

FONTLAB 7 Python API документация

Просмотр документации

Посетите fontlabcom.github.io/fontlab-python-docs, чтобы просмотреть документацию в браузере.

Создание документации

Установите Fontlab 7 и Python 2.7, который использует Fontlab.

В терминале или командной строке запустите:

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

Создание документов Python API Fontlab 7

Перейдите в папку fontlab7/build .

Откройте 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

Это построит документацию HTML с использованием mkdocs в docs/ папку.

Создание документов API FONTLAB 7 Pythonqt

Перейдите в папку pythonqt/build и продолжайте так же. Это встроит в папку docs/pythonqt .

Внесение в документацию

Прежде чем внести свой вклад в этот репозиторий, вы должны согласиться с лицензионным соглашением о лицензии FONTLAB

Простой

1. Посмотрите базовое имя (без расширения .md ) в папке srcdocs/mkdocs .
2. Перейдите в вики и создайте новую статью с тем же именем.
3. Напишите свой контент - мы рассмотрим его и перенесем его в официальные документы.

Передовой

Вилка репо.

fontlab7/srcdocs/ папка имеет три подпапки:

• docs содержит .md -файлы, которые будут включены в документацию в виде отдельных документов
• pre может содержать дополнительные .md -файлы, которые имеют те же имена, что и документы API с автогенерированием (например, typerig.core.objects.cubicbezier.md ): Содержание каждого такого файла будет приготовлено в файл DOC с автоматическим разработкой (вставлено после первого заголовка)
• post может содержать дополнительные файлы .md , которые имеют те же имена, что и документы API с автоматическим разработкой (например, typerig.core.objects.cubicbezier.md ): Содержание каждого такого файла будет добавлен в файл DOC (добавлено к концу)

Вы можете создавать новые документы в папках pre и post для улучшения автогенерируемого контента с помощью документации с человеком.

Создайте запрос на тягу, и мы рассмотрим его.

Файл pydocmk.yml yaml управляет процессом сборки, для получения подробной информации см. Pydocmk2.

Лицензия

Документация лицензирована по лицензии Apache 2. Copyright © 2017-2020 Fontlab Ltd.