צילום מסך תוכנה:
פרטי תוכנה:
כאשר נוצרו בפעם הראשונה, זה מטרה העיקרית הייתה לשמש כמחולל תיעוד עבור Python קוד שלך.
מאז, הגיע למצב הפרויקט פולחן בעולם הפיתוח, להיות אחד מהשפעות ההפניה ביותר בגנרטורים תיעוד האוטומטיים ביותר בסביבה, ללא קשר לשפה.
היום, חוץ מזה רק פייתון, הספינקס יכול לשמש גם עם קוד C ++ ו- C, כמו גם.
מה חדש בהודעה זו:
- להוסיף הנחיות נוחות ותפקידים לתחום ++ C: CPP הוראת ``: var`` ככינוי ל` `CPP: member``, תפקיד` `: CPP: var`` ככינוי ל``: CPP: חבר any` ``, ותפקיד `להפניה מקושרת לכל declaraction ++ C.
- : confval: 'ערך config source_suffix` יכול עכשיו להיות רשימה של סיומות מרובות .
- להוסיף את היכולת לציין מנתחי מקור על ידי סיומת מקור עם: confval:. 'ערך config source_parsers`
- קבלן חדש, AppleHelpBuilder, כבר הוסיף שבונה ספרי עזרה אפל.
מה חדש בגרסת 1.2.3 / 1.3b3:
- נוסף `` tuple sphinx.version_info`` לבדיקה תכנותית של גרסת הספינקס.
מה חדש בגרסת 1.1.3:
- התרסקות קבועה עם כמה הגדרות של: confval:. Modindex_common_prefix` '
- טיפול קבוע של `` `` -D`` ואפשרויות -A`` על פייתון 3.
- מוכר ולהתריע על toctrees המעגלי, במקום לרוץ לשגיאות רקורסיה.
- שחזור תאימות עם תא מטען docutils.
- קישורי רשומת אינדקס קבועים HTMLHelp שוב.
- inheritance_diagram הקבוע העלאת שגיאות תכונה על builtins.
- קריסות קבועים כאשר לשים הערות או מונחים בודדים במילון מונח.
- מיפוי שפה / קידוד עזרה HTML קבוע לכל הספינקס שפות נתמך.
מה חדש בגרסה 1.1:
- תכונות הוסיפו:
- תמיכת 3.x נוסף פייתון.
- קבלני המשנה וחדשים.
- שינויים לא תואמים:
- : ראשון: בימוי: `py: הוראת module` לא פלט` `ערך platform`` אפשרותה יותר. (זה היה הדבר היחיד שעשתה ההוראה פלט, ולכן די עקבי.)
- תמיכה הוסרה לגרסאות ישנות תלות.
- מקומות חדשים:
- . אזור שוודי נוסף
- . אזור האיראני נוסף
- . אזור לטבי נוסף
- . אזור נפאלית נוסף
- נוסף אזור קוריאני.
- . אזור אסטוני נוסף
מה חדש בגרסת 1.0.8:
- tracebacks תקן לAttributeErrors בדור autosummary.
- תקן `` abbr`` התפקיד כאשר יש קיצור שורות חדשים בזה.
- תקן הקישורים לתוצאות חיפוש עם סוגי אובייקט מותאם אישית.
- דווחו באזהרות על אזכור בלתי מוגדר.
- C ++ הגדרות תקן מערך וטיעוני תבנית שאינם להקליד שמות.
- אפשר הערות שוליים בכותרות סעיף בפלט LaTeX.
- מילות מפתח אפשר להיות מקושרים באמצעות intersphinx.
- אפשר תווי Unicode בשמות סמליים רשימת ייצור.
- להוסיף מבקרים דמה לצומת Graphviz לטקסט ואדם.
- באג כפילות קובץ תמונת תקן.
- ניתוח תיקון של חתימות מרובות בתחום של ++ C.
- התעלם קבצי מנעול Emacs כאשר מחפש קבצי מקור.
- אפשר הארכת .pyw עבור מודולים ליבוא בAutoDoc.
- $ השתמש `` (להפוך) `` בMakefiles-התחלה מהירה נוצרה.
- הפוך רוחב תיבת חיפוש סרגל צדדי עקבי בדפדפנים.
- מרווח תקן של דמויות מרוכזות בתפוקת HTML.
- בבטחה לקודד הודעות SphinxError בעת הדפסתם לsys.stderr.
- שגיאת LaTeX תקן פלט עם מסמך ללא סעיפים אבל קישור יעד.
- בצורה נכונה לטפל במתארי שיטה מובנית בשיטות בAutoDoc.
- תפסיק monkeypatching מודול textwrap פייתון.
- Viewcode כעת בצורה נכונה עם קבצי מקור שיש לי קידוד שאינו ASCII.
- כבד `אפשרות דגל noindex`` 'בפירו:. הנחיות מודול
- IndexErrors תקן כאשר כוללים nonexisting קווים עם: ראשון: בימוי:. 'Literalinclude`
- פונקציה מותאמת אישית בגין / מפריד פרמטר שיטה.
- אי התאמת JS תקן עם jQuery & gt;. = 1.5
- תקן קידוד כפול נעשה כאשר HTMLHelp .hhk כתיבה של קבצים.
- אין ליישם חכם בלילה בלוקים-מילוליים מנותחים.
- תחום C ++ תומך כעת הגדרות מערך.
מספרי קו תקן
מחרוזות
מה חדש בגרסת 1.0.6:
- traceback תקן בתחום של פייתון למטרות התייחסות צולבת ריקות.
- תקן בעיות תצוגת בלוק מילולית בדפדפני Chrome.
- תמיכת מיון מגוון מצומצם של דמויות מודגשים במדד הכללי והמילון המונח.
- נסה פענוח `` -D`` ו` `שורת הפקודה טיעוני -A`` עם הקידוד המועדף של האזור.
- שים לב: confval:. 'Locale_dirs` כאשר מחפש את קובץ תרגומי JS
- להוסיף קוד מיוחד לתמיכה טובה יותר של מסמכים יפניים בבונת LaTeX.
- רגרסיה של # 77: אם יש רק פרמטר אחד נתן עם ``: פרמטר:. `` סימון, רשימת הכדור כעת מדוכאת שוב
- תקן חסר הפסקות סעיף בפלט LaTeX במצבים מסוימים.
- לפלוט `` אירוע AutoDoc-התהליך-docstring`` אפילו עבור אובייקטים ללא docstring כך שהוא יכול להוסיף תוכן.
- בבונת LaTeX, לא רק בלוקים מילוליים דורשים טיפול שולחן שונה, אבל גם לא מעט אלמנטי בלוק כמו רשימה אחרות.
- tracebacks תיקון בהארכת viewcode לאובייקטי פייתון שאין לי חתימה תקפה.
- תקן reportings המוזר של מספרי שורות לאזהרות שנוצרו מdocstrings-כלול AutoDoc, בשל התנהגות שונה בהתאם לגרסת docutils.
- מספר תיקונים לתחום C ++.
מה חדש בגרסת 1.0.5:
- להוסיף סגנונות CSS הנדרשים על ידי docutils 0.7 עבור תמונות ודמויות מיושרות.
- בMakefile שנוצר על ידי פלט LaTeX, אל תמחק קבצי PDF על נקי; הם עלולים להידרש תמונות.
- פלט LaTeX תקן שנוצר עבור בלוקים קו.
- אפשר `` .pyw`` כסיומת קובץ מקור.
מה חדש בגרסת 1.0.4:
- מלאים להרחיב intersphinx במצב בינארי ב- Windows, מאז גרסה 2 מכילה נתוני דחוסים zlib.
- אפשר לתת URIs אינו מקומי עבור קבצי JavaScript, למשל בהארכת JSMath.
- traceback תקן כאשר `` intersphinx_mapping`` ריק.
מה חדש בגרסת 1.0.3:
- תקן פנימי מול קישור הבחנה חיצונית לקישורים המגיעים מdocutils שולחן-of-תוכן.
- תקן `` אפשרות maxdepth`` ל` `toctree ()` `תבנית callable בעת שימוש עם` `קריסה = True``.
- התרסקות תקן ניתוח רשימות טיעון פייתון מכילות סוגריים בliterals מחרוזת.
- רגרסיה תקן בעת בניית מסמכי LaTeX עם דמויות שאין לי כיתובים.
- תרשימי ירושת תקן לכיתות שאינם picklable.
- להציג את צבע רקע נפרד לכפתור קריסת סרגל הצד, מה שמקל לראות.
- תיקון באגים פריסה קטנים בכמה מובנה בנושאים.
מה חדש בגרסת 1.0.2:
- תקן הפניות לאובייקטים של סוגים נוספים על-ידי: func:. '~ פונקצית API .Sphinx.add_object_type`
- טיפול תקן של סוגי שדות doc לסוגים שונים הוראה.
- אפשר לשבור חתימות ארוכות, ממשיך בשורות החדשות-נמלט תגובה חריפה.
- תקן סטיילינג לא רצוי של אזכור תחום C (בגלל התנגשות מרחב עם סגנונות Pygments).
- אפשר אזכור PEPs וRFCs עם עוגנים מפורשים.
- אזכור LaTeX תיקון לדמויות.
- כאשר עושה חיפוש אינו מדויק,. התאמת הסוג נתון רק של אובייקט
- החל החיפוש הלא-מדויק למטרות התייחסות פייתון עם `` .name`` עבור מודולים מדי.
- התרסקות תקן כאשר לשכפל פרמטר ברשימת שדה מידע.
- תקן הגדרת תפקיד ברירת מחדל לאחד הניתן על ידי `` הארכת oldcmarkup``.
- התרסקות תקן כאשר JSON-פירו הוא מותקן, המספקת `` מודול json`` אבל אינה עולה בקנה לsimplejson.
- טיפול תקן של יעד השמות בintersphinx.
- הסרת תקן של ``! `` לכל תפקידי ההתייחסות צולבת.
מה חדש בגרסת 1.0.1:
- תקן שמות יעד שנוצרו עבור אובייקטי תחום לנוח; הם לא באותו המרחב.
- להוסיף שפה בנגלית.
- תיקון באג בניתוח שמות אובייקטי JavaScript.
- תקן בנייה עם SingleHTMLBuilder כאשר אין toctree.
- תצוגת תקן שמות לחפצים הקשורים בintersphinx עם מטרות מפורשות.
- תקן בנייה עם קבלן JSON.
- hyperrefs תקן בתיאורי אובייקט ל- LaTeX.
מה חדש בגרסת 1.0:
- כללי:
- נוסף במצב "קטנוני" שפולט אזהרות לכל אזכור של חסר. הוא מופעל על ידי: האפשרות: 'בורר שורת הפקודה -n` או: confval:.' ערך config nitpicky`
- `` יעד latexpdf`` נוסף בהתחלה המהירה Makefile.
- Markup:
- : ראשון: תפקיד: `menuselection` ו: ראשון: תפקיד:. 'תפקידי guilabel` תומכים כעת מאיצי אמפרסנד
- תחביר שדה דוק קומפקטי יותר חדש כעת מוכר: ``: שם סוג פרמטר:. Description``
- נוסף `` אפשרות כרטיסייה-width`` ל: ראשון: בימוי:. 'הוראת literalinclude`
- נוסף `` אפשרות titlesonly`` ל: ראשונה: בימוי:. 'הוראת toctree`
- נוסף prepend`` `` ו` `אפשרויות append`` ל: ראשון: בימוי:. 'הוראת literalinclude`
- כל docinfo מטה עכשיו הכניס לתוך metadata המסמך, לא רק המחבר.
- : הראשון: התפקיד: 'תפקיד ref` עכשיו יכול גם התייחסות שולחנות על ידי כיתוב .
- : ראשון: בימוי:. 'הוראת include` תומכת כעת נתיבים מוחלטים, שמתפרשים כביחס לספריית המקור
- בתחום פייתון, אזכור כמו ``: func:. '.name``` עכשיו לחפש שמות תואמים עם כל קידומת אם אין התאמה ישירה נמצאת
- תצורה:
- נוסף:. ערך config rst_prolog` ': confval
- נוסף: confval:. 'ערך config html_secnumber_suffix` לשלוט פורמט מספור סעיף
- נוסף: confval:. 'ערך config html_compact_lists` לשלוט כוללות הרשימות קומפקטיות' docutils
- : confval: 'ערך config html_sidebars` יכול כעת להכיל דפוסים כמפתחות, והערכים יכולים להיות רשימות שבמפורש לבחור שאמורה להיות מוצגות בתבניות סרגל צדדי. זה אומר שיכול להיות כלול תוכן הסרגל הצדדי builtin רק באופן סלקטיבי.
- : confval:. 'Html_static_path` יכול כעת להכיל ערכי קובץ אחד
- ערך config האוניברסלי החדש: confval: `exclude_patterns` עושה הישן: confval:` unused_docs`,: confval: `exclude_trees` ו: confval:. 'Exclude_dirnames` המיושן
- נוסף: confval:. 'ערך config html_output_encoding`
- נוסף: confval: 'ערך config latex_docclass` ועשה את אפשרות documentclass overridable ידי "oneside" "twoside" .
- נוסף: confval:. 'ערך config trim_doctest_flags`, מה שנכון כברירת מחדל
- נוסף: confval:. 'ערך config html_show_copyright`
- נוסף: confval: `latex_show_pagerefs` ו: confval:. 'ערכי config latex_show_urls`
- ההתנהגות של: confval: `html_file_suffix` השתנה מעט: המחרוזת הריקה עכשיו פירושו" אין סיומת "במקום" סיומת ברירת מחדל ", שימוש` `None`` ל" סיומת ברירת מחדל" .
- הבונים חדשים:
- נוסף בונה לפורמט ePub.
- נוסף בונה עבור דפי ספר.
- נוסף בונה HTML קובץ בודד.
- פלט HTML:
- עכשיו לקבל מעמד CSS עם השם שלהם, המאפשרים סגנונות כדי להתאים אישית את המראה שלהם. תפקידי תחום ספציפי יקבלו שתי כיתות, `` domain`` ו` `תחום-rolename``.
- הערות עכשיו לקבל המעמד `` internal`` אם הם פנימיים לכל הפרויקט, בניגוד לפנימי לדף הנוכחי.
- אזכור חיצוני שונה עם האפשרות החדשה `` externalrefs`` הנושא לנושא ברירת המחדל.
- בנושא ברירת המחדל, סרגל הצד יכול בניסוי עכשיו להתבצע מתקפל באמצעות האפשרות החדשה `` collapsiblesidebar`` הנושא.
- Toctrees עכשיו הם עטופים ב` `div`` תג עם מעמד` `toctree-wrapper`` בפלט HTML.
- : נתונים:. 'Toctree` callable בתבניות עכשיו יש `` ויכוח מילת המפתח maxdepth`` לשלוט העומק של העץ שנוצר
- : נתונים:. 'Toctree` callable בתבניות עכשיו מקבל `` ויכוח מילת המפתח titles_only``
- `` גוש נוסף htmltitle`` בתבנית פריסה.
- בחיפוש JavaScript, לאפשר מחפש שמות אובייקטים כוללים את שם מודול, כמו `` sys.argv``.
- נוסף נושא החדש `` haiku``, בהשראת המדריך למשתמש הייקו OS.
- נושא חדש נוסף nature`` ``.
- נוסף נושא חדש `` agogo``, נוצר על ידי אנדי אלברכט.
- נוסף נושא חדש `` scrolls``, נוצר על ידי ארמין Ronacher.
- נוסף `` אפשרות נושא visitedlinkcolor`` לנושא ברירת המחדל.
- היענות משופרת של דף החיפוש על ידי טעינת thesearch מדד אסינכרוני.
- API הארכה:
- נוסף: אירוע:. ' HTML-איסוף-pages`
- נוסף: confval: 'ערך needs_sphinx` config ו: ספיד:.' ~ שיטת API יישום sphinx.application.Sphinx.require_sphinx`
- נוסף: ספיד:. 'שיטת API יישום sphinx.application.Sphinx.add_stylesheet` ~
- הרחבות:
- נוסף: mod: `~ הארכת sphinx.ext.viewcode` .
- נוסף: mod: `~ הארכת sphinx.ext.extlinks` .
- תמיכה נוסף עבור הזמנת מקור של חברים בAutoDoc, עם `` autodoc_member_order = 'bysource'``.
- נוסף: confval:. 'Autodoc_default_flags` ערך config, אשר ניתן להשתמש בי לבחור דגלי ברירת מחדל עבור כל הנחיות AutoDoc
- נוסף בדרך לintersphinx להתייחס לתוויות שם בפרויקטים אחרים, וכדי לציין את הפרויקט שאתה רוצה לקשר אליו.
- AutoDoc עכשיו יכול לתעד למשל תכונות שהוקצה ב` `שיטות __init__``.
- רבים שיפורים ותיקונים ל: mod:. '~ הארכת sphinx.ext.autosummary`, הודות לפאולי Virtanen
- : mod: `~ הארכת sphinx.ext.graphviz` יכול SVG עכשיו פלט במקום תמונות PNG, הנשלט על ידי confval:. 'ערך config graphviz_output_format`
- נוסף `` אפשרות alt`` ל: ראשונה: בימוי:. 'הנחיות הארכת graphviz`
- כדי `` ויכוח נוסף exclude``: func:. .autodoc.between` '
- תרגומים:
- נוסף תרגום קרואטי, הודות לבויאן Mihelac.
- נוסף תרגום תורכי, הודות לFirat Ozgul.
- תרגום נוסף קטלאנית, הודות לפאו פרננדז.
- . נוסף תרגום סיני פשוטה
- נוסף תרגום דני, הודות להורת' לארסן.
- נוסף תרגום ליטאי, הודות לDalius Dobravolskas.
תפקידי Inline
יכול להיות מנוסח
מה חדש ב1.0b1 גרסה:
- תמיכה בתחומים נוספה לו. תחום הוא אוסף של הנחיות ותפקידים שכולם מתארים אובייקטים השייכים יחד, למשל אלמנטים של שפת תכנות. כמה תחומים builtin מסופקים: - Python - C - C ++ - JavaScript - reStructuredText
- . הסימון הישן להגדרה וקישור להוראות C לא עובד יותר ללא הפעלת `` הארכת oldcmarkup``
- תמיכה הוסרה לגרסאות ישנות תלות.
- הוסרו אלמנטים לא מומלצים לשימוש.
מה חדש בגרסה 0.6.5:
- בAutoDoc, לתקן את המחדל של חלק מחברי מודול במפורש המתועדים באמצעות הערות תיעוד.
- חיתוך תקן של פס גלילה סרגל צדדי עם `` אפשרות stickysidebar`` של ערכת נושא ברירת המחדל.
- תמיד ליצור שורות חדשות UNIX בMakefile ההתחלה המהיר.
- תקן פועל עם `` -C`` תחת Windows.
- בAutoDoc, מאפשר התאמה אישית של החתימה של אובייקט שבו המנגנון המובנה נכשל.
- פלט תקן לרשימות מנויות עם ערכי התחלה בLaTeX.
- הפוך `` להתחיל-after`` ו` `אפשרויות קצה before`` ל'עבודת הוראת literalinclude``` כראוי אם לא נעשה שימוש יחד.
- קישור דור תיקון בבונת LaTeX.
מה חדש בגרסה 0.6.4:
- משופר לטיפול במחרוזות-Unicode לא בתצורה.
- OSErrors תפוס מתרחש כאשר קוראים Graphviz עם טיעוניו אינו מבינים.
- שחזור תאימות עם Pygments & gt;. = 1.2
- תקן בריחה של מטרות hyperref בפלט LaTeX.
- קישורי תקן שנוצרו על ידי ``: דוק:. `` תפקיד לפלט LaTeX
- איסוף todo צמתים לאחר כל המסמך כבר לקרוא; זה מאפשר הצבת אזכור החלפה בtodo פריטים.
- אל תתעלם `` ערך מפורש today`` config בבניית LaTeX.
- 'טקסט' alt`` של דיאגרמות ירושה הוא עכשיו הרבה יותר נקי.
- התעלם תמונות בכותרות סעיפים בעת יצירת קישור כיתובים.
- הודעות למעט התמיכה ב` `בלוקים testoutput`` של` `הארכת doctest``.
- בלוקים קו מעוצבים כראוי בפלט HTML.
- תוצרת `עבודת ערך config locale_dirs`` 'שוב.
- `` ערכי html_context`` ניתנו בשורת הפקודה באמצעות `` -A`` לא צריך לעקוף ערכים אחרים שניתנו בconf.py.
- תיקון באג מניעה בונה מחדש מצטבר ל` `הבונה dirhtml``.
- תקן העיוות של ציטוטים בכמה בלוקים מילוליים.
- נתיב תקן לאינדקס החיפוש עבור `` הבונה dirhtml``.
- תקן בעיית תאימות Jython: להפוך את התלות ב` `מודול parser`` האופציונלי .
- בAutoDoc, לתפוס את כל השגיאות המתרחשות ביבוא מודול, לא רק `` ImportError``.
- תקן הטיפול של אי-נתונים, אבל לא שיטה בAutoDoc.
- בעת העתקת קובץ פעמים, להתעלם OSErrors שהועלה על ידי `` os.utime () ``.
מתארים
דרישות :
- Pygments 1.2 או גבוה
- ג'ינג'ה 2.3 או גבוה
- Docutils 0/7 או גבוהים יותר
תגובות לא נמצא