rst-buildhtml - מקוון בענן

תָכְנִית:

שֵׁם

rst-buildhtml - המר מסמכי reST רבים ל-HTML

תַקצִיר

rst-buildhtml [אפשרויות] [ ...]

תיאור

יוצר .html מכל קובצי ה-.txt reStructuredText (כולל PEPs) בכל אחד מהם
(ברירת המחדל היא הספרייה הנוכחית).

אפשרויות

כללי מסמכים אפשרויות
--title=כותרת
ציין את כותרת המסמך כמטא נתונים.

--גֵנֵרָטוֹר, -g
כלול קרדיט "נוצר על ידי דוקוטילים" וקישור.

--ללא מחולל
אל תכלול זיכוי מחולל.

--תַאֲרִיך, -d
כלול את התאריך בסוף המסמך (UTC).

--זְמַן, -t
כלול את השעה והתאריך (UTC).

--ללא חותמת תאריך
אל תכלול חותמת תאריך מכל סוג שהוא.

--מקור-קישור, -s
כלול קישור "הצג מקור מסמך".

--source-url=
להשתמש עבור קישור מקור; מרמז על --מקור-קישור.

--אין-מקור-קישור
אל תכלול קישור "הצג מקור מסמך".

--toc-entry-links back
קישור מכותרות מקטעים לערכי TOC. (בְּרִירַת מֶחדָל)

--toc-top-links back
קישור מכותרות הסעיפים לראש ה-TOC.

--אין-toc-links back
השבת קישורים נכנסים לתוכן העניינים.

--הערת שוליים-קישורים נכנסים
קישור מהערות שוליים/ציטוטים להפניות. (בְּרִירַת מֶחדָל)

--ללא הערות שוליים-קישורים נכנסים
השבת קישורים נכנסים מהערות שוליים וציטוטים.

--מספור מקטעים
אפשר מספור מקטעים לפי Docutils. (בְּרִירַת מֶחדָל)

--ללא מספור מקטעים
השבת מספור מקטעים על ידי Docutils.

--סטריפ-הערות
הסר רכיבי הערה מעץ המסמכים.

--להשאיר הערות
השאר רכיבי הערה בעץ המסמכים. (בְּרִירַת מֶחדָל)

--strip-elements-with-class=
הסר את כל הרכיבים עם classes=" " מעץ המסמכים. אזהרה:
סכנה אפשרית; להשתמש בזהירות. (אפשרות רב שימושית.)

--strip-class=
הסר את כל הכיתות=" " תכונות מאלמנטים בעץ המסמכים.
אזהרה: עלול להיות מסוכן; להשתמש בזהירות. (אפשרות רב שימושית.)

--דוח=, -r
דווח על הודעות מערכת ב- או גבוה מ : "מידע" או "1", "אזהרה"/"2"
(ברירת מחדל), "error"/"3", "severe"/"4", "none"/"5"

--מִלוּלִי, -v
דווח על כל הודעות המערכת. (זהה כמו "--report=1".)

--שֶׁקֶט, -q
אין לדווח על הודעות מערכת. (זהה כמו "--report=5".)

--halt=
עצירת ביצוע בהודעות מערכת בכתובת או מעליה . רמות כמו ב--rapport.
ברירת מחדל: 4 (חמור).

--קַפְּדָנִי
עצור בבעיה הקטנה ביותר. זהה ל-"--halt=info".

--exit-status=
אפשר סטטוס יציאה שאינו אפס עבור הודעות מערכת שאינן מפסיקות בכתובת או מעליה .
ברירת מחדל: 5 (מושבת).

--לנפות
אפשר הודעות מערכת ואבחון ברמת ניפוי באגים.

--ללא ניפוי באגים
השבת פלט ניפוי באגים. (בְּרִירַת מֶחדָל)

--אזהרות=
שלח את הפלט של הודעות המערכת אל .

--להתחקות
אפשר עקבות Python כאשר Docutils נעצר.

--ללא עקבות
השבת את מעקבי Python. (בְּרִירַת מֶחדָל)

--input-encoding=, -i
ציין את הקידוד ואופציונלי את מטפל השגיאות של טקסט הקלט. בְּרִירַת מֶחדָל:
:קַפְּדָנִי.

--input-encoding-error-handler=INPUT_ENCODING_ERROR_HANDLER
ציין את מטפל השגיאות עבור תווים בלתי ניתנים לפענוח. אפשרויות: "קפדנית" (ברירת מחדל),
"התעלם", ו"החלף".

--output-encoding=, -o
ציין את קידוד הטקסט ובאופן אופציונלי את מטפל השגיאות עבור הפלט. בְּרִירַת מֶחדָל:
UTF-8: קפדני.

--output-encoding-error-handler=OUTPUT_ENCODING_ERROR_HANDLER
ציין מטפל בשגיאות עבור תווי פלט בלתי ניתנים לקידוד; "קפדן" (ברירת מחדל),
"התעלם", "החלף", "xmlcharrefreplace", "החלפה אחורה".

--error-encoding=, -e
ציין קידוד טקסט ומטפל בשגיאות עבור פלט שגיאות. בְּרִירַת מֶחדָל:
ascii:backslashreplace.

--error-encoding-error-handler=ERROR_ENCODING_ERROR_HANDLER
ציין את מטפל השגיאות עבור תווים בלתי ניתנים לקידוד בפלט השגיאה. בְּרִירַת מֶחדָל:
החלפת נטוי אחורי.

--שפה=, -l
ציין את השפה (כתג שפה BCP 47). ברירת מחדל: en.

--record-dependencies=
כתוב תלות של קובץ פלט ל .

--config=
קרא את הגדרות התצורה מ , אם הוא קיים.

--גִרְסָה, -V
הצג את מספר הגרסה של תוכנית זו וצא.

- עזרה, -h
הצג את הודעת העזרה הזו וצא.

זריזות קורא אפשרות ברירות מחדל
אפשרויות --pep-references ו--rfc-references (עבור מנתח reStructuredText) פועלות
כברירת מחדל.

ReStructuredText מנתח אפשרויות
---pep-references
זיהוי וקשר להפניות PEP עצמאיות (כמו "PEP 258").

--pep-base-url=
כתובת אתר בסיס עבור הפניות PEP (ברירת מחדל "http://www.python.org/dev/peps/").

--pep-file-url-template=
תבנית עבור קובץ PEP חלק מ-URL. (ברירת מחדל "pep-%04d")

--rfc-references
זיהוי וקשר להפניות RFC עצמאיות (כמו "RFC 822").

--rfc-base-url=
כתובת אתר בסיס עבור הפניות RFC (ברירת מחדל "http://www.faqs.org/rfcs/").

--tab-width=
הגדר מספר רווחים להרחבת כרטיסיות (ברירת מחדל 8).

--trim-footnote-reference-space
הסר רווחים לפני הפניות להערות שוליים.

--להשאיר רווח-הערת שוליים
השאר רווחים לפני הפניות להערות שוליים.

--ללא הכנסת קובץ
השבת הנחיות שמכניסות את התוכן של קובץ חיצוני ("כלול" ו"גולמי");
הוחלף בהודעת מערכת "אזהרה".

---file-sertion-enabled
אפשר הנחיות שמכניסות את התוכן של קובץ חיצוני ("כלול" ו"גולמי").
מופעלת כברירת מחדל.

--לא-גולמי
השבת את הנחיות ה"גולמיות"; הוחלף בהודעת מערכת "אזהרה".

-- raw-enabled
אפשר את ההנחיה "גולמית". מופעל כברירת מחדל.

--syntax-highlight=
שם אסימון מוגדר לניתוח קוד עם פיגמנטים: אחד של "ארוך", "קצר" או "אין (לא)
ניתוח)". ברירת המחדל היא "ארוך".

--מרכאות-חכמות=SMART_QUOTES
שנה מרכאות ישרות לצורה טיפוגרפית: אחת מתוך "כן", "לא",
"alt[ernative]" (ברירת מחדל "לא").

HTML ספציפי אפשרויות
--תבנית=
ציין את קובץ התבנית (מקודד UTF-8). ברירת המחדל היא
"/usr/share/docutils/writers/html4css1/template.txt".

--גיליון סגנונות=
רשימה מופרדת בפסיק של כתובות אתרים של גיליונות סגנונות. עוקף את הקודם --stylesheet ו
---stylesheet-path הגדרות.

--stylesheet-path=
רשימה מופרדת בפסיק של נתיבי גיליון סגנונות. נתיבים יחסיים מורחבים אם יש התאמה
הקובץ נמצא ב--stylesheet-dirs. עם --link-stylesheet, הנתיב הוא
נכתב מחדש ביחס לקובץ HTML הפלט. ברירת מחדל: "html4css1.css"

--- embed-stylesheet
הטמע/י את גיליונות הסגנונות בקובץ ה-HTML של הפלט. קבצי גיליון הסגנונות חייבים להיות
נגיש במהלך העיבוד. זוהי ברירת המחדל.

--גיליון סגנונות קישור
קישור לגיליונות הסגנונות בקובץ ה-HTML של הפלט. ברירת מחדל: הטמעת גיליונות סגנונות.

--stylesheet-dirs=
רשימה מופרדת בפסיקים של ספריות שבהן נמצאות גיליונות סגנונות. בשימוש ע"י
--stylesheet-path בעת הרחבת ארגומנטים של נתיב יחסי. ברירת מחדל: "['.',
'docutils/writers/html4css1']"

--initial-header-level=
ציין את רמת הכותרת הראשונית. ברירת המחדל היא 1 עבור " ". לא משפיע
כותרת מסמך וכותרת משנה (ראה --no-doc-title).

--field-name-limit=
ציין את הרוחב המרבי (בתווים) עבור שמות שדות בעמודה אחת. ארוך יותר
שמות שדות יתפרשו על שורה שלמה של הטבלה המשמשת לעיבוד רשימת השדות.
ברירת המחדל היא 14 תווים. השתמש ב-0 עבור "ללא הגבלה".

--Option-limit=
ציין את הרוחב המרבי (בתווים) עבור אפשרויות ברשימות אפשרויות. ארוך יותר
אפשרויות יתפרשו על שורה שלמה של הטבלה המשמשת לעיבוד רשימת האפשרויות.
ברירת המחדל היא 14 תווים. השתמש ב-0 עבור "ללא הגבלה".

--הערת שוליים-הפניות=
פורמט להפניות להערות שוליים: אחד מ"כתב על" או "סוגריים". ברירת המחדל היא
"סוֹגְרַיִם".

--ייחוס=
פורמט עבור ייחוס ציטוטים בלוק: אחד של "מקף" (קידומת em-dash),
"סוגריים"/"parents", או "אין". ברירת המחדל היא "מקף".

--רשימות קומפקטיות
הסר רווח אנכי נוסף בין פריטים של רשימות תבליטים "פשוטות" ו
רשימות ממומנות. ברירת מחדל: מופעלת.

--ללא רשימות קומפקטיות
השבת תבליטים פשוטים קומפקטיים ורשימות ממומנות.

--רשימות-שדות קומפקטיות
הסר רווח אנכי נוסף בין פריטים של רשימות שדות פשוטות. בְּרִירַת מֶחדָל:
מאופשר.

--ללא רשימות-שדות קומפקטיות
השבת רשימות שדות פשוטות קומפקטיות.

---table-style=TABLE_STYLE
נוסף לשיעורי טבלה סטנדרטיים. סגנונות מוגדרים: "ללא גבולות". ברירת מחדל: ""

--מתמטיקה-פלט=MATH_OUTPUT
פורמט פלט מתמטי, אחד של "MathML", "HTML", "MathJax" או "LaTeX". ברירת מחדל: "HTML
math.css"

--no-xml-declaration
השמט את הצהרת ה-XML. השתמש בזהירות.

--כתובות-אימייל-גלימה
ערפל כתובות דוא"ל כדי לבלבל את הקוצרים תוך שמירה על קישורי דוא"ל
שמיש עם דפדפנים התואמים לתקנים.

PEP/HTML ספציפי אפשרויות
עבור כותב PEP/HTML, ערך ברירת המחדל עבור האפשרות --stylesheet-path הוא
"/usr/share/docutils/writers/pep_html/pep.css", וערך ברירת המחדל עבור --template הוא
"/usr/share/docutils/writers/pep_html/template.txt". ראה אפשרויות ספציפיות ל-HTML למעלה.

--python-home=
כתובת האתר הביתית של Python. ברירת המחדל היא "http://www.python.org".

--pep-home=
קידומת כתובת אתר הבית עבור PEPs. ברירת המחדל היא "." (ספרייה נוכחית).

בניית HTML אפשרויות
--שחזור
סרוק רקורסיבית ספריות משנה לקבצים לעיבוד. זוהי ברירת המחדל.

--מְקוֹמִי
אל תסרוק ספריות משנה לעיבוד קבצים.

--Prune=
אל תעבד קבצים ב (דפוסי כדורי קונכיות, מופרדים על ידי נקודתיים).
ניתן להשתמש באפשרות זו יותר מפעם אחת כדי לציין מספר ספריות. בְּרִירַת מֶחדָל:
".hg:.bzr:.git:.svn:CVS".

--התעלם=
התעלם באופן רקורסיבי מקבצים התואמים לכל אחד מהתו הכללי הנתון (גלוב של מעטפת)
דפוסים (מופרדים על ידי נקודתיים).

--שקט
עבוד בשקט (ללא הודעות התקדמות). בלתי תלוי ב"--שקט".

--ריצה יבשה
אל תעבדו קבצים, הראו קבצים שיעובדו.

RST-BUILDHTML(1)

השתמש ב-rst-buildhtml באינטרנט באמצעות שירותי onworks.net