sphinxcontrib-קפה הוא הרחבה הספינקס שמוסיפה תחום CoffeeScript עם תמיכת AutoDoc לספינקס.
זה מסתמך על coffeedoc_ לחלץ הערות מקור מ` `קבצי .coffee``. כדי להתקין coffeedoc גלובלי ::
& Nbsp; NPM להתקין coffeedoc -g
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
שימוש
ראשית עליך להוסיף את הסיומת לרשימת הסיומות בconf.py שלך:
& Nbsp; = סיומות ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
בגלל Python אין לו מושג על איפה המקורות שלך, אתה חייב לומר לו איפה לחפש בconf.py שלך כך:
& Nbsp; coffee_src_dir = os.path.abspath ("../ ')
לבסוף, אם הפרויקט שלך הוא בעיקר CoffeeScript, ייתכן שתרצה להגדיר את התחום הראשי וכן:
& Nbsp; primary_domain = 'קפה'
הוראות ותפקידים
תחום זה מספק הנחיות מודול, פונקציה, כיתה ושיטה, כמו גם ספיד, בכיתה, ותפקידי func להצלבה. כדי התייחסות לאובייקט אחר, להשתמש בו שם מלא מוסמך: שם מודול, מעי גס כפול, ואת הנתיב הנפרד הנקודה לאובייקט בתוך מודול.
לדוגמא, להתייחסות `` פונקצית swizzle`` בקובץ `` lib / widgets.coffee``, לכתוב ``: קפה: func: `lib / יישומונים :: swizzle``. אתם יכולים להוריד את `` המוביל: coffee`` אם התחום הראשי שלך הוגדר לקפה, ואתה יכול להוריד את שם מודול IFF אתה מקשר מתוך `` lib / מודול widgets``.
AutoDoc
אתה יכול לתעד מודולים כל בקלות עם `` automodule``:
.. :: Sourcecode הראשון
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : חברים:
דרישות :
- Python
תגובות לא נמצא