זוהי הפקודה sphinx-build שניתן להריץ בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות המרובות שלנו, כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS
תָכְנִית:
שֵׁם
sphinx-build - כלי מחולל תיעוד ספינקס
תַקצִיר
בניית ספינקס [אפשרויות]sourcedir>outdir> [שמות קבצים ...]
תיאור
בניית ספינקס יוצר תיעוד מהקבצים ב וממקם אותו ב
.
בניית ספינקס מחפש /conf.py עבור הגדרות התצורה.
ספינקס-התחלה מהירה(1) עשוי לשמש ליצירת קובצי תבניות, כולל conf.py.
בניית ספינקס יכול ליצור תיעוד בפורמטים שונים. פורמט נבחר על ידי
ציון שם הבנאי בשורת הפקודה; ברירת המחדל היא HTML. גם בונים יכולים
לבצע משימות אחרות הקשורות לעיבוד תיעוד.
כברירת מחדל, כל מה מיושן בנוי. פלט רק עבור קבצים נבחרים יכול להיות
נבנה על ידי ציון שמות קבצים בודדים.
רשימת בונים זמינים:
html יצירת קבצי HTML. זהו בונה ברירת המחדל.
dirhtml
יצירת קובץ HTML עם כל קובץ HTML בשם "index.html" בנפרד
במדריך.
singlehtml
יצירת קבצי HTML עם כל התוכן בקובץ HTML בודד.
html עזרה
יוצר קבצים ליצירת CHM (קבצי עזרה מהודרים).
qthelp יוצר קבצים ליצירת אוסף עזרה של Qt.
devhelp
יוצר קבצים עבור מציג העזרה של GNOME Devhelp.
שרף גומי יוצר פלט LaTeX שניתן להרכיב למסמך PDF.
איש יוצר דפים ידניים.
texinfo
מייצר פלט Texinfo שניתן לעבד על ידי makeinfo כדי ליצור מידע
מסמך.
ePub יוצר גרסת ספר אלקטרוני ePub של פלט HTML.
טֶקסט יוצר גרסת טקסט רגיל של התיעוד.
gettext
יוצר קטלוגים של הודעות Gettext לתרגום תוכן.
שינויים
יוצר קובצי HTML עם פריטים שהשתנו/נוספו/הוצאו משימוש עבור הגרסה הנוכחית
של הפרויקט המתועד.
קישור לבדוק
בודק את תקינות כל הקישורים החיצוניים במקור.
מלפפונים חמוצים / ג'סון
יוצר קבצי HTML בסידרה לשימוש ביישומי אינטרנט.
xml יוצר קובצי XML מקוריים של Docutils.
pseudoxml
מייצר קבצי "פסאודו-XML" קומפקטיים מודפסים למדי המציגים את הפנימי
מבנה עצי מסמכי הביניים.
אפשרויות
-b
בונה לשימוש; ברירת המחדל היא html. ראה את הרשימה המלאה של בונים למעלה.
-a צור פלט עבור כל הקבצים; ללא אפשרות זו רק פלט עבור חדשים ושונים
נוצר קבצים.
-E התעלם מקבצי מטמון, מאלץ לקרוא מחדש את כל קבצי המקור מהדיסק.
-d
נתיב לקבצים מאוחסנים; ברירת המחדל ל /.doctrees.
-j לבנות במקביל ל-N תהליכים במידת האפשר.
-c
אתר את קובץ conf.py בנתיב שצוין במקום .
-C ציין שאין להשתמש בקובץ conf.py כלל. ניתן להגדיר רק תצורה
עם אפשרות -D.
-D
תעקוף הגדרה מקובץ התצורה.
-t
לְהַגדִיר תג לשימוש בלוקים "בלבד".
-A
העבר ערך לתבניות HTML (רק עבור בוני HTML).
-n הפעל במצב חריף, הזהר לגבי כל ההפניות החסרות.
-v הגבר את מידת המלל (ניתן לחזור על עצמו).
-N מניעת פלט צבעוני.
-q פעולה שקטה, רק הדפס אזהרות ושגיאות ב-stderr.
-Q פעולה שקטה מאוד, אל תדפיס שום דבר מלבד שגיאות.
-w
כתוב אזהרות ושגיאות בקובץ הנתון, בנוסף ל-stderr.
-W הפוך אזהרות לשגיאות.
-T הצג עקבות מלאה על חריגה.
-P הפעל Pdb על חריג.
השתמש ב-sphinx-build באינטרנט באמצעות שירותי onworks.net