Sphinx

البرمجيات قطة:
Sphinx
تفاصيل البرنامج:
الإصدار: 1.3.1 محدث
تاريخ إيداع: 12 May 15
المطور: Georg Brandl
ترخيص: حرر
شعبية: 54

Rating: nan/5 (Total Votes: 0)

عند أنشئت لأول مرة، انها الهدف الرئيسي هو بمثابة مولد وثائق لرمز بيثون نفسه.
منذ ذلك الحين، وصل المشروع مركز عبادة في عالم التنمية، كونها واحدة من اهم تأثيرات المشار إليها في مولدات الوثائق الأكثر تلقائية حولها، وبغض النظر عن اللغة.
اليوم، إلى جانب فقط بيثون، أبو الهول يمكن أن تستخدم أيضا مع C و C ++ كود كذلك.

ما هو الجديد في هذا الإصدار:



إضافة الراحة توجيهات والأدوار إلى مجال C ++: توجيهي `` حزب الشعب الكمبودي: var`` كما مستعار ل`` حزب الشعب الكمبودي: member``، دور ``: حزب الشعب الكمبودي: var`` كما مستعار ل``: حزب الشعب الكمبودي: member``، ودور `any` للإحالة إلى أي C ++ declaraction.
و: confval: `يمكن أن تكون قيمة التكوين source_suffix` الآن قائمة لاحقات متعددة.
إضافة القدرة على تحديد موزعي المصدر عن طريق احقة مصدر في: confval: `قيمة التكوين source_parsers`.
وبناء جديد، AppleHelpBuilder، وقد أضاف أن يبني تعليمات Apple كتب.

ما هو الجديد في الإصدار 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.
بناة جديدة والفرعي.
التغييرات غير المتوافقة:
و: RST: دير: `الحمر: التوجيه module` لا إخراج` قيمة الخيار platform`` لها `بعد الآن. (وهذا هو الشيء الوحيد الذي التوجيه لم الإخراج، وبالتالي تتعارض تماما).
دعم إزالة للإصدارات التبعية القديمة.
غات جديدة:
وأضاف اللغة السويدية.
وأضاف المحلية الإيرانية.
وأضاف اللغة اللاتفية.
وأضاف اللغة النيبالية.
وأضاف اللغة الكورية.
وأضاف اللغة الاستونية.

ما هو الجديد في الإصدار 1.0.8:



إصلاح tracebacks لAttributeErrors في الجيل autosummary.
إصلاح `` abbr`` دور عندما اختصار له أسطر جديدة في ذلك.
إصلاح الروابط إلى النتائج مع أنواع الكائنات بحث مخصص.
إصلاح خط الأعداد الواردة في تحذيرات حول المراجع غير محددة.
إصلاح C ++ تعريفات مجموعة والحجج القالب الذي لم يتم كتابة أسماء.
يسمح الحواشي في رؤوس قسم في انتاج مطاط.
السماح كلمات لتكون مرتبطة عبر intersphinx.
السماح أحرف Unicode في قائمة أسماء إنتاج رمزية.
إضافة زوار وهمية لعقد graphviz للنص والرجل.
إصلاح ملف صورة الازدواجية علة.
إصلاح إعراب توقيعات متعددة في مجال C ++.
تجاهل الملفات قفل إيماكس عندما تبحث عن ملفات المصدر.
السماح تمديد .pyw لوحدات استيرادها في autodoc.
استخدام `` $ (جعل) `` في المولدة التشغيل السريع Makefiles.
جعل البحث الشريط الجانبي عرض مربع متسقة في المتصفحات.
إصلاح تباعد من الشخصيات تركزت في إخراج HTML.
بأمان ترميز الرسائل SphinxError عند طباعتها لsys.stderr.
إصلاح الخطأ الناتج اللثي وثيقة مع عدم وجود أقسام ولكن الهدف الارتباط.
صحيح علاج المدمج في واصفات طريقة كأساليب في autodoc.
وقف monkeypatching وحدة textwrap بيثون.
Viewcode يعمل الآن بشكل صحيح مع ملفات المصدر التي تحتوي على ترميز غير ASCII.
احترام خيار العلم `` noindex`` في الحمر: توجيهات حدة.
إصلاح IndexErrors عندما انعدم تماما بما في ذلك خطوط مع: RST: دير: `literalinclude`.
احترام وظيفة مخصص / طريقة سلاسل فاصل المعلمة.
إصلاح JS عدم التوافق مع مسج & GT؛ = 1.5.
إصلاح الترميز المزدوج القيام به عند كتابة الملفات HTMLHelp .hhk.
لا تنطبق SmartyPants في كتل تحليل-حرفية.
يدعم نطاق C ++ الآن تعريفات مجموعة.

ما هو الجديد في الإصدار 1.0.6:



إصلاح traceback في مجال بيثون لأهداف الإحالة فارغة.
إصلاح مشاكل العرض كتلة الحرفية على متصفحات كروم.
دعم فرز مجموعة محدودة من أحرف معلمة في المؤشر العام والمسرد.
محاولة فك `` `-A`` وسائط سطر الأوامر -D`` و` مع ترميز اللغة المفضل ل.
ملاحظة: confval: `locale_dirs` عندما تبحث عن ملف ترجمة JS.
إضافة رمز خاص للدعم أفضل للوثائق اليابانية في بناء مطاط.
إذا كان هناك معلمة واحدة فقط تعطى مع ``: المعلمة: `` العلامات، ويتم قمع قائمة رصاصة الآن مرة أخرى تراجع # 77.
إصلاح فواصل الفقرة المفقودة في الناتج مطاط في بعض الحالات.
ينبعث `` الحدث autodoc-عملية docstring`` حتى لكائنات دون docstring حتى تتمكن من إضافة المحتوى.
في باني اللثي، وليس فقط لبنات حرفية تتطلب معالجة جدول مختلف، ولكن أيضا عدد غير قليل من العناصر الأخرى كتلة القائمة مثل.
إصلاح tracebacks في ملحق viewcode للكائنات بيثون التي ليس لديها توقيع صالح.
إصلاح reportings غريبة من أرقام الأسطر تحذيرات الناتجة عن جمل التوثيق تضمين autodoc، بسبب سلوك مختلفة اعتمادا على docutils الإصدار.
عدة إصلاحات إلى مجال C ++.

ما هو الجديد في الإصدار 1.0.5:



إضافة أنماط CSS التي تتطلبها docutils 0.7 للصور وشخصيات الانحياز.
في ماكيفيلي الناتجة عن انتاج مطاط، لا تقم بحذف ملفات PDF على نظيفة. لأنها قد تكون مطلوبة الصور.
إصلاح انتاج مطاط ولدت لكتل ​​الخط.
سماح `` .pyw`` كامتداد الملف المصدر.

ما هو الجديد في الإصدار 1.0.4:



مخزونات intersphinx مفتوحة في وضع ثنائي على ويندوز، منذ الإصدار 2 يحتوي على بيانات مضغوطة زليب.
السماح إعطاء محددات غير الحكومية المحلية لملفات جافا سكريبت، على سبيل المثال في ملحق JSMath.
إصلاح traceback عندما `` intersphinx_mapping`` فارغ.

ما هو الجديد في الإصدار 1.0.3:



إصلاح مقابل الداخلي التمييز وصلة خارجية للحصول على ارتباطات القادمة من docutils محتويات الجدول ل.
إصلاح `` الخيار maxdepth`` ل`` toctree () `` قالب للاستدعاء عند استخدامها مع `` انهيار = True``.
إصلاح تحطم تحليل القوائم حجة بيثون تحتوي على الأقواس في سلسلة حرفية.
إصلاح الانحدار عند بناء مستندات اللثي مع الشخصيات التي ليس لديها تعليق.
إصلاح المخططات الميراث لفئات التي لم يتم picklable.
إدخال لون الخلفية منفصل لزر انهيار الشريط الجانبي، مما يجعل من السهل أن نرى.
إصلاح الخلل تخطيط الصغيرة في العديد من الموضوعات المضمنة.

ما هو الجديد في الإصدار 1.0.2:



إصلاح إحالات إلى كائنات من أنواع أضيفت من قبل: وظائفها: `~ وظيفة API .Sphinx.add_object_type`.
إصلاح التعامل مع من أنواع الحقول وثيقة لأنواع مختلفة التوجيه.
السماح كسر التوقيعات طويلة، مع استمرار أسطر جديدة نجا رد فعل عنيف.
إصلاح التصميم غير المرغوب فيها من المراجع مجال C (بسبب اشتباك مساحة الاسم مع أنماط Pygments).
السماح إشارات إلى ممثلي المخاطر والمراجع مع المراسي صريحة.
إصلاح المراجع مطاط للأرقام.
عند القيام بعملية بحث غير المحدد، مباراة فقط نوع معين من الجسم.
تطبيق البحث غير المحدد للأهداف المرجعية بيثون مع `` .name`` لوحدات جدا.
إصلاح تحطم عند تكرار معلمة في قائمة المعلومات الميدانية.
إصلاح وضع دور الافتراضية إلى واحدة التي تقدمها `` تمديد oldcmarkup``.
إصلاح تحطم عند تثبيت سلمان-الحمر، والتي توفر `` وحدة json`` لكن غير متوافق إلى simplejson.
إصلاح التعامل مع التسمية الهدف في intersphinx.
إصلاح إزالة `` `` لجميع الأدوار الإحالة.

ما هو الجديد في الإصدار 1.0.1:



إصلاح الأسماء المستهدفة الناتجة عن كائنات المجال راحة. فهي ليست في مساحة الاسم نفسه.
إضافة اللغة البنغالية.
إصلاح الخلل في توزيع أسماء الكائنات جافا سكريبت.
إصلاح بناء مع SingleHTMLBuilder عندما لا يكون هناك toctree.
إصلاح أسماء العرض للكائنات مرتبطة من قبل intersphinx مع أهداف واضحة.
إصلاح بناء مع البناء JSON.
إصلاح hyperrefs في وصف الكائن للمطاط.

ما هو الجديد في الإصدار 1.0:



عام:
وأضاف وضع "nitpicky" التي تنبعث تحذيرات لجميع المراجع في عداد المفقودين. يتم تنشيطه من قبل: الخيار: `-n` تبديل سطر الأوامر أو: confval:` قيمة التكوين nitpicky`.
وأضاف `` latexpdf`` الهدف في التشغيل السريع ماكيفيلي.
العلامات:
و: RST: دور: `menuselection` و: RST: دور:` الأدوار guilabel` الآن دعم مسرعات علامة العطف.
ومن المسلم الجديد أكثر إحكاما جملة الحقل وثيقة الآن: ``: المعلمة اسم نوع: description``.
وأضاف `` خيار التبويب width`` إلى: RST: دير: `التوجيه literalinclude`.
وأضاف `` الخيار titlesonly`` إلى: RST: دير: `التوجيه toctree`.
واضاف `` `` prepend`` وخيارات append`` إلى: RST: دير: `التوجيه literalinclude`.
يتم وضع جميع البيانات الوصفية docinfo الآن إلى البيانات الوصفية وثيقة، وليس فقط للمؤلف.
و: RST: دور: يمكن أن `دور ref` الآن تشير أيضا الجداول التوضيحية.
و: RST: دير: `التوجيه include` الآن يدعم مسارات مطلقة، والتي تفسر على أنها نسبة إلى الدليل المصدر.
في المجال بيثون، والمراجع مثل ``: ظائفها: `.name``` ننظر الآن لمطابقة الأسماء مع أي بادئة إذا تم العثور على أي مباراة مباشرة.
التكوين:
وأضاف: confval: `قيمة التكوين rst_prolog`.
وأضاف: confval: `قيمة html_secnumber_suffix` التهيئة للسيطرة على تنسيق الترقيم القسم.
وأضاف: confval: `قيمة التكوين html_compact_lists` للسيطرة على ميزة القوائم المدمجة docutils.
و: confval: `يمكن أن تحتوي html_sidebars` قيمة التكوين الآن أنماط كمفاتيح، ويمكن أن تكون القيم القوائم التي حدد بشكل واضح مما ينبغي تقديم قوالب الشريط الجانبي. وهذا يعني أن محتويات الشريط الجانبي مدمج يمكن تضمينها بشكل انتقائي فقط.
: confval: `html_static_path` يمكن أن تحتوي الآن إدخالات ملف واحد.
الجديد عالمية قيمة التكوين: confval: `exclude_patterns` يجعل العمر: confval:` unused_docs`،: confval: `exclude_trees` و: confval:` exclude_dirnames` عفا عليها الزمن.
وأضاف: confval: `قيمة التكوين html_output_encoding`.
أضاف: confval: `قيمة التكوين latex_docclass` وجعل" twoside "الخيار documentclass للتجاوز من قبل" oneside ".
أضاف: confval: `قيمة التكوين trim_doctest_flags`، وهو صحيح افتراضيا.
وأضاف: confval: `قيمة التكوين html_show_copyright`.
وأضاف: confval: `latex_show_pagerefs` و: confval:` القيم التكوين latex_show_urls`.
سلوك: confval: `html_file_suffix` تغيرت قليلا: سلسلة فارغة الآن يعني" لا لاحقة "بدلا من" لاحقة الافتراضي "، واستخدام` `None`` ل" احقة الافتراضي ".
بناة الجديدة:
وأضاف باني لEPUB شكل.
وأضاف باني لصفحات اليدوية.
وأضاف باني HTML ملف واحد.
إخراج HTML:
الأدوار المضمنة الآن الحصول على الدرجة CSS مع اسمهم، مما يسمح أساليب لتخصيص مظهرها. الأدوار الخاصة بالمجال الحصول على فئتين، `` `` domain`` والمجال rolename``.
مراجع الآن الحصول على الدرجة `` internal`` إذا كانت داخلية للمشروع ككل، وبدلا من الداخلية إلى الصفحة الحالية.
مراجع خارجية يمكن أن تكون على غرار مختلف مع `` الخيار موضوع جديد externalrefs`` لموضوع التقصير.
في موضوع افتراضي، يمكن تجريبيا الآن بذل الشريط الجانبي للطي باستخدام `الخيار موضوع collapsiblesidebar`` الجديد`.
واختتم Toctrees الآن في `` div`` العلامة مع الطبقة `` toctree-wrapper`` في الناتج HTML.
و: البيانات: `toctree` للاستدعاء في قوالب لديها الآن` `حجة الكلمة maxdepth`` للسيطرة على عمق الشجرة التي تم إنشاؤها.
و: البيانات: `toctree` للاستدعاء في قوالب يقبل الآن` `حجة الكلمة titles_only``.
وأضاف `` كتلة htmltitle`` في قالب تخطيط.
في البحث وجافا سكريبت، تسمح بالبحث عن أسماء الكائنات بما في ذلك اسم الوحدة النمطية، مثل `` sys.argv``.
وأضاف موضوع جديد `` haiku``، مستوحاة من دليل المستخدم هايكو OS.
وأضاف موضوع جديد `` nature``.
وأضاف موضوع جديد `` agogo``، التي أنشأتها اندى ألبرشت.
وأضاف موضوع جديد `` scrolls``، التي أنشأتها ارمين Ronacher.
إضافة `` الخيار موضوع visitedlinkcolor`` إلى السمة الافتراضية.
تحسين الاستجابة للصفحة البحث عن طريق تحميل thesearch مؤشر بشكل غير متزامن.
تمديد API:
وأضاف: الحدث: `-أتش تي أم أل اجمع-pages`.
وأضاف: confval: `قيمة التكوين needs_sphinx` و: المنهجيات:` ~ طريقة API تطبيق sphinx.application.Sphinx.require_sphinx`.
وأضاف: المنهجيات: `~ طريقة API تطبيق sphinx.application.Sphinx.add_stylesheet`.
الامتدادات:
واضاف: وزارة الدفاع: `~ تمديد sphinx.ext.viewcode`.
واضاف: وزارة الدفاع: `~ تمديد sphinx.ext.extlinks`.
واضاف لدعم طلب المصدر من أعضاء في autodoc، مع `` autodoc_member_order = 'bysource'``.
وأضاف: confval: `قيمة التكوين autodoc_default_flags`، والتي يمكن استخدامها لتحديد أعلام الافتراضي لجميع التوجيهات autodoc.
وأضاف وسيلة للintersphinx للإشارة إلى تسميات وردت أسماؤهم في مشاريع أخرى، وتحديد المشروع الذي تريد الارتباط به.
Autodoc يمكن الآن توثيق المثال سمات المخصصة في `` أساليب __init__``.
العديد من التحسينات والإصلاحات ل: وزارة الدفاع: `~ تمديد sphinx.ext.autosummary`، وذلك بفضل باولي فيرتانن.
من: وزارة الدفاع: `~ تمديد sphinx.ext.graphviz` يمكن الآن SVG إخراج بدلا من الصور PNG، التي تسيطر عليها confval:` قيمة التكوين graphviz_output_format`.
وأضاف `` الخيار alt`` إلى: RST: دير: `توجيهات تمديد graphviz`.
وأضاف `` حجة exclude`` إلى: ظائفها: `.autodoc.between`.
ترجمة:
وأضاف الترجمة الكرواتية، وذلك بفضل بويان Mihelac.
وأضاف الترجمة التركية، وذلك بفضل فرات OZGUL.
وأضاف الترجمة التشيكية، وذلك بفضل باو فرنانديز.
وأضاف مبسطة الترجمة الصينية.
وأضاف الترجمة الدانماركية، وذلك بفضل Hjorth لارسن.
وأضاف الترجمة الليتوانية، وذلك بفضل داليوس Dobravolskas.

ما هو الجديد في النسخة 1.0b1:



تمت إضافة دعم المجالات. A المجال هو عبارة عن مجموعة من التوجيهات والأدوار التي عن وصف الأشياء التي تنتمي معا، على سبيل المثال عناصر من لغة البرمجة. وتقدم عدد قليل من المجالات مدمج: - بايثون - C - C ++ - جافا سكريبت - reStructuredText
فإن العلامات القديمة لتحديد وربط لتوجيهات C لا تعمل بعد الآن دون تفعيل `` تمديد oldcmarkup``.
دعم إزالة للإصدارات التبعية القديمة.
إزالة العناصر إهمال.

ما هو الجديد في الإصدار 0.6.5:



في autodoc، وتحديد إغفال بعض أعضاء وحدة موثقة بشكل واضح استخدام التعليقات الوثائق.
إصلاح الاقتصاص من الشريط الجانبي شريط التمرير مع `` الخيار stickysidebar`` من السمة الافتراضية.
تولد دائما أسطر جديدة UNIX في ماكيفيلي التشغيل السريع.
إصلاح تعمل مع `` -C`` تحت ويندوز.
في autodoc، تسمح تخصيص توقيع كائن حيث فشل آلية المضمنة.
إصلاح الناتج عن القوائم المذكورة مع القيم البداية في اللاتكس.
جعل `` بدء after`` و`` خيارات نهاية before`` إلى `` literalinclude`` العمل التوجيه بشكل صحيح إذا لم تستخدم جنبا إلى جنب.
إصلاح جيل الرابط في بناء مطاط.

ما هو الجديد في الإصدار 0.6.4:



تحسن التعامل مع سلاسل غير Unicode في التكوين.
OSErrors الصيد التي تحدث عند استدعاء graphviz بحجج أنه لا يفهم.
استعادة التوافق مع Pygments & GT؛ = 1.2.
إصلاح الهروب من الأهداف hyperref في انتاج مطاط.
إصلاح الروابط التي تم إنشاؤها بواسطة ``: وثيقة: `` دور للانتاج مطاط.
جمع ما يجب عمله العقد بعد أن تم قراءة الوثيقة بأكملها. هذا يسمح وضع إشارات استبدال البنود في ما يجب عمله.
لا تجاهل `` قيمة التكوين today`` صريحة في بناء مطاط.
و`` النص alt`` من المخططات الميراث هو الآن أنظف بكثير.
تجاهل الصور في عناوين الأقسام عند إنشاء التسميات الارتباط.
الرسائل باستثناء الدعم في `` testoutput`` كتل من `` تمديد doctest``.
وعلى غرار كتل خط صحيح في إخراج HTML.
جعل `العمل قيمة التكوين locale_dirs``` مرة أخرى.
`` القيم html_context`` معين على سطر الأوامر عبر `` -A`` لا ينبغي أن تلغي القيم الأخرى الواردة في conf.py.
إصلاح الخلل منع يعيد بناء الإضافية ل`` باني dirhtml``.
إصلاح تغيير اسم من يقتبس في بعض الكتل حرفية.
إصلاح المسار إلى فهرس البحث عن `` باني dirhtml``.
إصلاح مشكلة التوافق جيثون: جعل الاعتماد على `` وحدة parser`` اختيارية.
في autodoc، قبض على جميع الأخطاء التي تحدث على وحدة الواردات، وليس فقط `` ImportError``.
إصلاح التعامل مع غير البيانات، ولكن اصفات غير الأسلوب في autodoc.
عند نسخ ملف الأوقات، وتجاهل OSErrors التي أثارها `` os.utime () ``.

المتطلبات:



Pygments 1.2 أو أعلى
جينجا 2.3 أو أعلى
Docutils 0/7 أو أعلى

لقطات

sphinx-77594_1_77594.png
sphinx-77594_2_77594.png

برامج مماثلة

Gollum
Gollum

9 Apr 16

T3
T3

18 Apr 16

phpDocumentor
phpDocumentor

13 May 15

WackoWiki
WackoWiki

1 May 16

البرامج الأخرى من المطور Georg Brandl

Sphinx
Sphinx

14 Apr 15

Pygments
Pygments

14 Apr 15

تعليقات ل Sphinx

لم يتم العثور على التعليقات
إضافة تعليق
بدوره على الصور!
البحث حسب الفئة