Kunjungi fontlabcom.github.io/fontlab-python-docs untuk melihat dokumentasi di browser.
Instal FontLab 7 dan Python 2.7 yang digunakan FontLab.
Di terminal atau baris perintah, jalankan:
python2 -m pip install --user --upgrade git+https://github.com/twardoch/pydocmk2
Pergi ke folder fontlab7/build .
Buka build_fontlab7_api_docs.vfpy di fontlab 7 dan tunggu sampai paket pydocmk2 menghasilkan file -file markdown ke folder fontlab7/srcdocs/mkdocs .
Di terminal, pergi ke folder fontlab7/build dan jalankan:
python2 -m mkdocs build -v -f ../mkdocs.yml --dirty
atau, di macOS, klik dua kali build_fontlab7_api_docs.command
Ini akan membangun dokumentasi HTML menggunakan mkdocs ke dalam docs/ folder.
Pergi ke folder pythonqt/build , dan lanjutkan dengan cara yang sama. Ini akan dibangun ke dalam folder docs/pythonqt .
Sebelum Anda berkontribusi pada repositori ini, Anda harus menyetujui Perjanjian Lisensi Kontributor Individual FontLab
.md ) di folder srcdocs/mkdocs .Garpu repo.
fontlab7/srcdocs/ folder memiliki tiga subfolder:
docs berisi file .md yang akan dimasukkan dalam dokumentasi sebagai dokumen terpisahpre mungkin berisi file .md opsional yang memiliki nama yang sama dengan dokumen API autogenerated (misalnya typerig.core.objects.cubicbezier.md ): Konten masing -masing file tersebut akan disiapkan ke file DOC yang diotogenasi (dimasukkan setelah header pertama)post dapat berisi file .md opsional yang memiliki nama yang sama dengan dokumen API autogenerated (misalnya typerig.core.objects.cubicbezier.md ): Konten masing -masing file tersebut akan ditambahkan ke file DOC yang diotogenerasi (ditambahkan ke akhir) Anda dapat membuat dokumen baru di folder pre dan post untuk meningkatkan konten autogenerasi dengan dokumentasi yang ditulis manusia.
Buat permintaan tarik dan kami akan mempertimbangkannya.
File pydocmk.yml YAML mengontrol proses pembuatan, lihat pydocmk2 untuk detailnya.
Dokumentasi dilisensikan di bawah lisensi Apache 2. Hak Cipta © 2017-2020 Fontlab Ltd.