sphinxcontrib-רשימת תגיות היא הרחבה "רשימת תגיות" הספינקס.
רשימת תגיות
רשימת תגיות היא הרחבה למערכת תיעוד הספינקס.
התקנה
שרותי דרך פיפס:
PIP להתקין sphinxcontrib-רשימת תגיות
או באמצעות GitHub:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-רשימת תגיות
פיתון setup.py להתקין
בשלב הבא, יש לך להוסיף סיומת ל'conf.py 'בפרויקט ספינקס שלך.
= סיומות [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist',
& Nbsp; ...]
תצורה
בעת שימוש בתגים עם סיומת זו ייתכן שתרצה לתת לכל תג בצבע אחר. אתה יכול לעשות את זה ב'conf.py 'על ידי הוספה:
taglist_tags = {
& Nbsp; 'tag1': {: 'ירוק' 'צבע רקע'}
}
הוראות
תג:
& Nbsp; הוראת תג להוסיף "חתיכה" של מידע, ואתה יכול לתייג אותו.
& Nbsp; אתה יכול להשתמש בו כמו:
& Nbsp; .. תג :: כמה מידע מתויג
& Nbsp;: תג: TAG3 tag2 tag1
& Nbsp; או:
& Nbsp; .. תג :: [TAG3 tag2 tag1] חלק מהמידע מתויג
& Nbsp; אזהרה: שיטה השנייה הוא להשתמש רק אם השיטה הראשונה היא לא.
& nbsp; אזהרה: אני לא בטוח תחביר זה, זה עשוי להשתנות. אם יש לך הצעות אנני בבקשה ליידע אותי.
רשימת תגיות:
& Nbsp; רשימת תגיות היא הוראה שתתפוס את התגים ולעשות רשימה.
& Nbsp; ראשית הוא מדפיס "תגיות: ..." עם מידע שמתייג אותה מציג, ויותר מזה מציג את הרשימה.
& Nbsp; אתה יכול להשתמש בו כמו:
& Nbsp; .. רשימת תגיות ::
& Nbsp;: תגים: TAG3 tag1
איך זה עובד?
בסיס הקוד נגזר מsphinxcontrib-דרישות כך זה עובד באופן דומה.
במהלך מסמך הנחיות תג קריאה ליצור tag_node`s. `רשימה תגיות ליצור צמתים רשימת תגיות.
במהלך פתרון צמתים רשימת תגיות משתנים לפיסת תגיות טקסט: עם תגי פריטים שיוצגו ברשימה. הבא הוא מדפיס את כל פריטים המתויגים.
CSS
taglist.css:
& Nbsp; הוא מכיל מחלקת בסיס לתג - taglist_tag
& Nbsp; אזהרה: זה כנראה יהיה שונה ולשים בtaglist_tags.css. (וזה יהיה להגדרה מתוך conf.py)
בנוסף, הוא יוצר taglist_tags.css הקובץ במהלך עיבוד (עם css עבור כל תג שהגדרת בconf.py; taglist_tags ממפה את כל מפתחות התג למפתחות css). ולכתוב בו כדי לבנות ספרייה לקבצים סטטיים
דרישות :
- Python
- הספינקס
תגובות לא נמצא