fontlab python docs

Documentação da API do Fontlab 7 Python

Visualizando a documentação

Visite o fontlabcom.github.io/fontlab-python-docs para visualizar a documentação no navegador.

Construindo a documentação

Instale o FontLab 7 e o Python 2.7 que o Fontlab usa.

No terminal ou na linha de comando, execute:

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

Construindo o Fontlab 7 Python API Docs

Vá para a pasta fontlab7/build .

Open build_fontlab7_api_docs.vfpy no Fontlab 7 e aguarde até que os pacotes pydocmk2 gerem os arquivos de marcação na pasta fontlab7/srcdocs/mkdocs .

No terminal, vá para a pasta fontlab7/build e execute:

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

Ou, no macOS, clique duas vezes em build_fontlab7_api_docs.command

Isso criará a documentação HTML usando mkdocs na pasta docs/ .

Construindo o Fontlab 7 Pythonqt API Docs

Vá para a pasta pythonqt/build e prossiga da mesma maneira. Isso será construído na pasta docs/pythonqt .

Contribuindo para a documentação

Antes de contribuir com este repositório, você deve concordar com o contrato de licença de colaborador individual do Fontlab

Simples

1. Procure um nome base (sem a extensão .md ) na pasta srcdocs/mkdocs .
2. Vá ao Wiki e crie um novo artigo com o mesmo nome.
3. Escreva seu conteúdo - vamos revisá -lo e movê -lo para os documentos oficiais.

Avançado

Bifurcar o repo.

A pasta fontlab7/srcdocs/ possui três subpastas:

• docs contêm arquivos .md que serão incluídos na documentação como documentos separados
• pre pode conter arquivos .md opcionais que possuem os mesmos nomes que os documentos da API autogenerados (por exemplo, typerig.core.objects.cubicbezier.md ): o conteúdo de cada arquivo será prévio para o arquivo DOC autogenerado (inserido após o primeiro cabeçalho)
• post pode conter arquivos .md opcionais que têm os mesmos nomes que os documentos da API autogenerados (por exemplo, typerig.core.objects.cubicbezier.md ): o conteúdo de cada arquivo será anexado ao arquivo DOC autogenerado (adicionado ao fim)

Você pode criar novos documentos em pastas pre e post para aprimorar o conteúdo autogenerado com a documentação de autoria humana.

Crie uma solicitação de tração e nós o consideraremos.

O arquivo yaml pydocmk.yml controla o processo de compilação, consulte Pydocmk2 para obter detalhes.

Licença

A documentação é licenciada sob a licença Apache 2. Copyright © 2017-2020 Fontlab Ltd.