เยี่ยมชม fontlabcom.github.io/fontlab-python-docs เพื่อดูเอกสารในเบราว์เซอร์
ติดตั้ง Fontlab 7 และ Python 2.7 ที่ Fontlab ใช้
ในเทอร์มินัลหรือบรรทัดคำสั่งเรียกใช้:
python2 -m pip install --user --upgrade git+https://github.com/twardoch/pydocmk2
ไปที่โฟลเดอร์ fontlab7/build
เปิด build_fontlab7_api_docs.vfpy ใน fontlab 7 และรอจนกว่าแพ็คเกจ pydocmk2 จะสร้างไฟล์ markdown ลงในโฟลเดอร์ fontlab7/srcdocs/mkdocs
ในเทอร์มินัลไปที่โฟลเดอร์ fontlab7/build แล้วเรียกใช้:
python2 -m mkdocs build -v -f ../mkdocs.yml --dirty
หรือบน macOS, ดับเบิลคลิกที่ build_fontlab7_api_docs.command
สิ่งนี้จะสร้างเอกสาร HTML โดยใช้ mkdocs ลงใน docs/ โฟลเดอร์
ไปที่โฟลเดอร์ pythonqt/build และดำเนินการในลักษณะเดียวกัน สิ่งนี้จะสร้างลงในโฟลเดอร์ docs/pythonqt
ก่อนที่คุณจะมีส่วนร่วมในที่เก็บนี้คุณจะต้องยอมรับข้อตกลงใบอนุญาตผู้มีส่วนร่วมของ Fontlab
.md ) ในโฟลเดอร์ srcdocs/mkdocsส้อม repo
fontlab7/srcdocs/ Folder มีโฟลเดอร์ย่อยสามแบบ:
docs มีไฟล์ .md ที่จะรวมอยู่ในเอกสารเป็นเอกสารแยกต่างหากpre อาจมีไฟล์ .md ที่เป็นตัวเลือกที่มีชื่อเดียวกันกับเอกสาร API Autogenerated (เช่น typerig.core.objects.cubicbezier.md ): เนื้อหาของแต่ละไฟล์ดังกล่าวจะถูก เตรียม ไปยังไฟล์ DOC แบบอัตโนมัติpost อาจมีไฟล์ .md ที่เป็นตัวเลือกที่มีชื่อเดียวกันกับเอกสาร API Autogenerated (เช่น typerig.core.objects.cubicbezier.md ): เนื้อหาของแต่ละไฟล์ดังกล่าวจะถูก ผนวกเข้า กับไฟล์ Doc Autogenerated (เพิ่มลงในตอนท้าย) คุณสามารถสร้างเอกสารใหม่ในโฟลเดอร์ pre และ post เพื่อปรับปรุงเนื้อหา Autogenerated ด้วยเอกสารที่เขียนโดยมนุษย์
สร้างคำขอดึงและเราจะพิจารณา
ไฟล์ pydocmk.yml yaml ควบคุมกระบวนการสร้างโปรดดูรายละเอียด PyDocmk2
เอกสารได้รับอนุญาตภายใต้ใบอนุญาต Apache 2 ลิขสิทธิ์© 2017-2020 Fontlab Ltd.