ספינקס-הוא כלי פייתון שייצור פגז תיעוד הספינקס לפרויקט שלך וכולל את קובץ README כמדד התיעוד & nbsp;. הוא מטפל חילוץ meta נתונים הנדרשים כגון פרויקט שם, מחבר וגרסה משלך פרויקט לשימוש במסמכי הספינקס שלך.
ברגע שאתה משתמש בספינקס-לי לבנות מסמכי הספינקס שלך, אז אתה יכול להוסיף את הפרויקט שלך לאתר קרא Docs ויש README של הפרויקט שלך מתארח עם נושא תיעוד הספינקס אטרקטיבי.
הערה: קובץ README שלך צריך להיות בפורמט תואם reStructuredText.
התקנה
הדרך הקלה ביותר להתקנת ספינקס-הוא ישירות מPyPI באמצעות PIP או setuptools ידי הפעלת הפקודה המתאימה להלן:
PIP להתקין -U ספינקס-לי
או:
ספינקס-easy_install -U
אחרת אתה יכול להוריד ספינקס-לי ולהתקין אותו ישירות ממקור:
פיתון setup.py להתקין
הפעלה
שלי-ספינקס יותקן כתסריט מערכתי שניתן להפעיל משורת הפקודה ואילו בספריית השורש של הפרויקט שלך:
ספינקס-לי
כאשר לרוץ בספרייה של הפרויקט שלך, זה יהיה ליצור ספריית מסמכים עם שני קבצים, מודול conf.py הספינקס, וקובץ index.rst שיכלול README של הפרויקט שלך.
מודול conf.py קורא התקנת פונקציה מספינקס-לי שמגדיר את המינימום דרוש להגדרות מסמכי הספינקס שלך.
- פרויקט - שם הספרייה של הפרויקט שלך משמש.
- גרסה - שהובאה מarg הגרסה של התסריט שלך setup.py, או תכונת __version__ של החבילה שלך.
- זכויות יוצרים - שהובאו מarg מחבר התסריט שלך setup.py, או תכונת __author__ של החבילה שלך
דרישות :
- . פייתון
תגובות לא נמצא