sphinxcontrib กาแฟเป็นส่วนขยายของสฟิงซ์ที่เพิ่มโดเมน CoffeeScript ด้วยการสนับสนุน AutoDoc กับ Sphinx
นี้อยู่บนพื้นฐาน coffeedoc_ เพื่อดึงแหล่งความคิดเห็นจาก `` ไฟล์ .coffee`` การติดตั้ง coffeedoc ทั่วโลก ::
& nbsp; NPM ติดตั้ง -g coffeedoc
.. _coffeedoc: https://github.com/omarkhan/coffeedoc
การใช้งาน
ก่อนอื่นคุณต้องเพิ่มส่วนขยายในรายการของคุณของนามสกุลใน conf.py:
& nbsp; นามสกุล = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
เพราะงูใหญ่มีเบาะแสเกี่ยวกับที่แหล่งที่มาของคุณจะไม่มีคุณต้องบอกว่าที่จะมองไปใน conf.py คุณชอบโดย:
& nbsp; coffee_src_dir = os.path.abspath ('../')
สุดท้ายหากโครงการของคุณเป็นหลัก CoffeeScript คุณอาจต้องการที่จะกำหนดโดเมนหลักเช่นกัน:
& nbsp; primary_domain = 'กาแฟ'
Directives และบทบาท
โดเมนนี้มีโมดูลการทำงานของชั้นเรียนและแนวทางวิธีการเช่นเดียวกับการปรุงยาชั้นและบทบาท func สำหรับการอ้างอิงข้าม เพื่อที่จะอ้างอิงวัตถุอื่นใช้มันเป็นชื่อที่มีคุณสมบัติทั้งหมด: ชื่อโมดูล, ลำไส้ใหญ่คู่และเส้นทางที่แยกจากจุดไปยังวัตถุภายในโมดูล
ตัวอย่างเช่นการอ้างอิง `` ฟังก์ชั่น swizzle`` ในแฟ้ม `` lib / widgets.coffee`` เขียน ``: กาแฟ: func: `lib / เครื่องมือ :: swizzle`` คุณสามารถวางชั้นนำ ``: coffee`` ถ้าโดเมนหลักของคุณได้รับการตั้งค่าให้เครื่องชงกาแฟและคุณสามารถวางชื่อโมดูล IFF คุณมีการเชื่อมโยงจากภายใน `` lib / โมดูล widgets``
AutoDoc
คุณสามารถเอกสารโมดูลทั้งหมดได้อย่างง่ายดายด้วย `` automodule``:
.. sourcecode :: แรก
& nbsp; .. automodule :: mymodule
& nbsp; & nbsp; & nbsp; : สมาชิก:
ต้องการ
- หลาม
ความคิดเห็นที่ไม่พบ