نرم افزار تصویر:
جزئیات نرم افزار:
هنگام برای اولین بار ایجاد شده، آن را هدف اصلی این بود که به عنوان یک ژنراتور مستندات کد خود پایتون خدمت می کنند.
از آن زمان، این پروژه تا به وضعیت فرقه در جهان توسعه رسیده است، که یکی از تأثیرات ترین اشاره شده در ژنراتور مستندات خودکار ترین در اطراف، بدون در نظر گرفتن زبان.
امروز، علاوه بر فقط پایتون، مجسمه ابوالهول و همچنین می توانید با C و C ++ کد نیز مورد استفاده قرار گیرد.
در چه در این نسخه جدید است:
اضافه کردن دستورات راحتی و نقش به دامنه C ++: بخشنامه `` CPP: var`` به عنوان نام مستعار برای `` CPP: member``، نقش ``: CPP: var`` به عنوان نام مستعار برای ``: CPP: member``، و نقش `any` برای ارجاع به هر C ++ declaraction.
: confval: `ارزش پیکربندی source_suffix` هم اکنون می توانید یک لیست از پسوند های متعدد باشد.
اضافه کردن توانایی برای مشخص کردن منبع تجزیه کننده شده توسط منبع با پسوند: confval: `ارزش پیکربندی source_parsers`.
سازنده جدید، AppleHelpBuilder، اضافه شده است که می سازد اپل راهنما کتاب.
در چه جدید در نسخه 1.2.3 است / 1.3b3:
اضافه `` تاپل 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 ++ تعریف آرایه ها و استدلال قالب که نام نوع نیست.
اجازه پانوشت در هدر بخش در خروجی لاتکس.
کلمات کلیدی اجازه می دهد تا از طریق intersphinx مرتبط است.
اجازه می دهد از کاراکترهای یونیکد در لیست تولید نام رمز.
اضافه کردن آخرین بازدید نوک پستان گره graphviz برای متن و مرد است.
رفع اشکال فایل تصویر تکراری.
رفع تجزیه امضا چند در حوزه C ++.
نادیده گرفتن فایل های قفل ایمکس هنگامی که به دنبال فایل های منبع.
اجازه می دهد توسعه .pyw برای ماژول های وارداتی در autodoc.
استفاده از `` $ (مطمئن) `` در شروع سریع تولید Makefile ها.
را جستجو نوار کناری عرض جعبه سازگار در مرورگرهای.
رفع فاصله از چهره های محور در خروجی HTML.
با خیال راحت رمز پیام های SphinxError هنگام چاپ آنها را به sys.stderr.
رفع خطا در خروجی لاتک را با یک سند بدون بخشهای اما یک هدف لینک کنید.
درست ساخته شده است در توصیف روش به عنوان روش درمان در autodoc.
توقف monkeypatching ماژول پایتون textwrap.
Viewcode در حال حاضر به درستی با فایل های منبع را پشتیبانی می کند که غیر ASCII کار می کند.
دستورات ماژول: `` گزینه پرچم noindex`` در PY احترام بگذارند.
رفع IndexErrors هنگامی که از جمله خطوط ناموجود با: اول: دیر: `literalinclude`.
احترام تابع سفارشی / روش رشته جدا پارامتر.
رفع ناسازگاری JS با jQuery & gt؛ به = 1.5.
ثابت را پشتیبانی می کند دو برابر انجام هنگام نوشتن فایل های HTMLHelp .hhk.
آیا SmartyPants در بلوک تجزیه-اللفظی صدق نمی کند.
دامنه C ++ در حال حاضر تعاریف آرایه پشتیبانی می کند.
در نسخه 1.0.6 چه جدید است:
رفع traceback در حوزه پایتون برای اهداف ارجاع خالی می باشد.
رفع مشکلات مربوط به نمایش بلوک اللفظی در مرورگرهای Chrome.
پشتیبانی مرتب سازی طیف محدودی از شخصیت های لهجه در شاخص عمومی و واژه نامه.
سعی کنید رمز گشایی `` `استدلال خط فرمان -A`` -D`` و` با رمزگذاری ترجیح مکان است.
مشاهده: confval: `locale_dirs` زمانی که به دنبال برای ترجمه فایل JS.
اضافه کردن کد خاص برای پشتیبانی بهتر از اسناد ژاپن در سازنده لاتک.
رگرسیون # 77: در صورتی که فقط یک پارامتر داده شده با `` وجود دارد: PARAM: `` نشانه گذاری، لیست گلوله در حال حاضر دوباره سرکوب شده است.
رفع معافیت بند گم شده در خروجی لاتک را در موقعیت های خاص.
منتشر می کنند `` رویداد autodoc-فرایند docstring`` حتی برای اشیاء بدون رشته مستندساز به طوری که آن را می توانید محتوای اضافه کنید.
در سازنده لاتک، نه تنها بلوک اللفظی نیاز به دست زدن به جدول های مختلف، بلکه کاملا چند دیگر مانند لیست عناصر بلوک.
رفع tracebacks در گسترش viewcode برای اشیاء پایتون که یک امضای معتبر ندارد.
رفع reportings عجیب و غریب از شماره خط برای هشدار تولید شده از docstrings-autodoc شامل، با توجه به رفتار متفاوت بسته به نسخه docutils.
تعدادی اصلاحیه به دامنه C ++.
در نسخه 1.0.5 چه جدید است:
اضافه کردن سبک های CSS مورد نیاز docutils 0.7 برای تصاویر و ارقام تراز.
در makefile در خروجی تولید شده توسط لاتک، فایل PDF در تمیز را حذف کنید. آنها ممکن است تصاویر مورد نیاز است.
ثابت خروجی لاتک تولید شده برای بلوک خط.
اجازه `` .pyw`` به عنوان فرمت فایل منبع.
در نسخه 1.0.4 چه جدید است:
موجودی intersphinx گسترش در حالت باینری بر روی ویندوز، پس از نسخه 2 شامل داده zlib می متراکم می شود.
اجازه دادن URI ها غیر محلی برای فایل های جاوا اسکریپت، به عنوان مثال در گسترش JSMath.
رفع traceback زمانی که `` intersphinx_mapping`` خالی است.
در نسخه 1.0.3 چه جدید است:
ثابت در مقابل داخلی تمایز لینک خارجی برای لینک از یک docutils جدول از محتویات.
رفع `` گزینه maxdepth`` برای `` toctree () `` قالب قابل بازخرید زمانی که با `` فروپاشی = True`` استفاده می شود.
ثابت تصادف تجزیه لیست بحث پایتون حاوی براکت در رشته.
ثابت رگرسیون در هنگام ساختن اسناد لیتک با آمار و ارقام که نوشتن شرح تصاویر و ندارد.
رفع نمودار ارث برای کلاس که در حال picklable نیست.
معرفی رنگ پس زمینه جداگانه برای دکمه فروپاشی نوار کناری، و آن را آسان تر برای دیدن.
رفع اشکالات طرح کوچک در چند ساخته شده است در تم ها.
در نسخه 1.0.2 چه جدید است:
رفع ارجاعات متقابل به اشیاء از انواع اضافه شده توسط: تابع: `~ تابع API .Sphinx.add_object_type`.
ثابت دست زدن به انواع درست توضیحات برای انواع مختلف بخشنامه.
اجازه شکستن امضا طولانی، مداوم با خط جدید-عکس العمل فرار کردند.
رفع یک ظاهر طراحی شده ناخواسته از C مراجع دامنه (به دلیل درگیری فضای نام با سبک های Pygments).
اجازه ارجاع به PEPs و RFC ها با مجریان صریح است.
رفع مراجع لاتکس به اعداد و ارقام.
هنگام انجام یک جستجوی غیر دقیق، مطابقت تنها نوع داده از شی.
درخواست جستجوی غیر دقیق آن برای اهداف پایتون مرجع با `` .name`` برای ماژول های بیش از حد.
ثابت تصادف در هنگام تکثیر یک پارامتر در یک لیست درست اطلاعات.
ثابت تنظیم نقش به طور پیش فرض به یک ارائه شده توسط `` پسوند oldcmarkup``.
ثابت تصادف در هنگام JSON-PY نصب شده است، فراهم می کند که `` ماژول json`` اما ناسازگار به simplejson است.
ثابت دست زدن به نامگذاری هدف در intersphinx.
ثابت حذف ``! `` برای همه نقش ارجاع متقابل.
در نسخه 1.0.1 چه جدید است:
رفع نام هدف تولید برای استراحت اشیاء دامنه. آنها در فضای نام یکسان نیست.
اضافه کردن زبان بنگالی.
رفع اشکال در تجزیه نام شی جاوا اسکریپت.
ثابت ساخت با SingleHTMLBuilder زمانی که هیچ toctree وجود دارد.
رفع نام برای اشیاء توسط intersphinx مرتبط با اهداف صریح و روشن صفحه نمایش.
ثابت ساخت با سازنده JSON.
رفع hyperrefs در توصیف شی برای لاتکس.
در چه در نسخه 1.0 جدید است:
عمومی:
اضافه شدن یک حالت "nitpicky" که هشدارهای برای همه مراجع از دست رفته خود ساطع میکند. گزینه:: `-n` سوئیچ خط فرمان و یا: confval:` ارزش پیکربندی nitpicky` این است که توسط فعال می شود.
اضافه `` latexpdf`` هدف در شروع سریع makefile در.
نشانه گذاری:
: اول: نقش: `menuselection` و: اول: نقش:` نقش guilabel` در حال حاضر شتاب دهنده علامت حمایت می کنند.
جدید جمع و جور تر نحو درست توضیحات در حال حاضر شناخته شده است: ``: PARAM نام نوع: description``.
اضافه `` گزینه تب-width`` به: اول: دیر: `بخشنامه literalinclude`.
اضافه `` گزینه titlesonly`` به: اول: دیر: `بخشنامه toctree`.
اضافه `` `` prepend`` و گزینه append`` به: اول: دیر: `بخشنامه literalinclude`.
همه ابرداده docinfo در حال حاضر به ابرداده سند، نه فقط نویسنده قرار داده است.
: اول: نقش: `نقش ref` هم اکنون می توانید جداول توسط عنوان مرجع است.
: اول: دیر: `بخشنامه include` در حال حاضر مسیرهای مطلق، که به عنوان نسبت به دایرکتوری منبع تفسیر پشتیبانی می کند.
در حوزه پایتون، مراجع مانند ``: تابع: `.name``` در حال حاضر برای تطبیق با هر پیشوند نام نگاه کنید اگر هیچ بازی مستقیم پیدا می شود.
تنظیمات:
اضافه شده: confval: `ارزش پیکربندی rst_prolog`.
اضافه شده: confval: `ارزش پیکربندی html_secnumber_suffix` برای کنترل فرمت شماره بخش.
اضافه شده: confval: `html_compact_lists` ارزش پیکربندی لیست های کنترل جمع و جور docutils 'ویژگی.
: confval: `html_sidebars` ارزش پیکربندی در حال حاضر می تواند شامل الگوهای به عنوان کلید، و ارزش می تواند لیست هایی که به صراحت را انتخاب کنید که از قالب های نوار کناری باید نمایش داده شود. این بدان معناست که محتویات نوار کناری builtin را می توان تنها انتخابی.
: 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 overridable توسط" 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:
اضافه شده در: رویداد: `HTML غیر-جمع آوری-pages`.
اضافه شده: confval: `ارزش پیکربندی needs_sphinx` و: مت:` ~ برنامه sphinx.application.Sphinx.require_sphinx` روش API.
اضافه شده: مت: `~ روش برنامه sphinx.application.Sphinx.add_stylesheet` API.
برنامه های افزودنی:
اضافه شده: وزارت دفاع: `~ پسوند sphinx.ext.viewcode`.
اضافه شده: وزارت دفاع: `~ پسوند sphinx.ext.extlinks`.
اضافه شدن پشتیبانی برای سفارش منبع از اعضای در autodoc، با `` autodoc_member_order = 'bysource'``.
اضافه شده: confval: `ارزش پیکربندی autodoc_default_flags`، که می تواند مورد استفاده قرار گیرد را انتخاب کنید به طور پیش فرض پرچم برای همه دستورات autodoc.
اضافه شدن یک راه را برای intersphinx برای اشاره به برچسب نام در پروژه های دیگر، و برای مشخص کردن پروژه شما می خواهید به لینک به.
Autodoc هم اکنون می توانید به عنوان مثال سند صفات در `` روش __init__`` اختصاص داده است.
بسیاری از پیشرفت ها و رفع به: وزارت دفاع: `~ پسوند sphinx.ext.autosummary`، به لطف پائولی Virtanen.
: وزارت دفاع: `~ پسوند sphinx.ext.graphviz` هم اکنون می توانید SVG خروجی به جای تصاویر PNG، توسط confval کنترل:` ارزش پیکربندی graphviz_output_format`.
اضافه `` گزینه alt`` به: اول: دیر: `دستورات پسوند graphviz`.
اضافه `` استدلال exclude`` به: تابع: `.autodoc.between`.
ترجمه:
اضافه ترجمه کرواتی، به لطف بویان Mihelac.
اضافه ترجمه ترکی، به لطف فیرات Ozgul.
اضافه ترجمه کاتالان، به لطف به Pau فرناندز.
اضافه شده ساده ترجمه چینی.
اضافه ترجمه دانمارکی، به لطف Hjorth لارسن.
اضافه ترجمه لیتوانیایی، به لطف Dalius Dobravolskas.
در چه در نسخه جدید 1.0b1 است:
پشتیبانی از دامنه اضافه شده است. دامنه مجموعه ای از دستورات و نقش که تمام اشیاء توصیف متعلق با هم، به عنوان مثال است عناصر یک زبان برنامه نویسی. برخی از دامنه ها builtin ارائه شده: - پایتون - C - C ++ - جاوا اسکریپت - reStructuredText
نشانه گذاری قدیمی برای تعریف و لینک دادن به دستورات C دیگر بدون فعال کردن `` پسوند oldcmarkup`` کار نخواهد کرد.
پشتیبانی برای نسخه های حذف وابستگی های قدیمی.
حذف عناصر منسوخ شده است.
در نسخه 0.6.5 چه جدید است:
در autodoc، تعمیر حذف برخی از اعضای ماژول به صراحت مستند با استفاده از نظرات اسناد.
رفع کشت از نوار اسکرول ستون کناری با `` گزینه stickysidebar`` از تم پیش فرض.
همیشه خط جدید UNIX در makefile در شروع سریع را تولید کند.
ثابت در حال اجرا با `` -C`` تحت ویندوز.
در autodoc، اجازه می دهد سفارشی امضای یک شی که در آن ساز و ساخته شده است در نتواند.
ثابت خروجی برای لیست شمارش با ارزش شروع در لاتکس.
را `` راه after`` و `` گزینه نهایی before`` به `` کار بخشنامه literalinclude`` به درستی اگر با هم استفاده نمی شود.
ثابت نسل لینک در سازنده لاتک.
در نسخه 0.6.4 چه جدید است:
بهبود مدیریت رشته های غیر یونیکد در پیکربندی.
OSErrors بگیر اتفاق می افتد زمانی که خواستار graphviz با استدلال آن را درک نمی کنند.
بازگرداندن سازگاری با Pygments & gt؛ به = 1.2.
رفع فرار از اهداف hyperref در خروجی لاتکس.
لینک های ثابت تولید شده توسط ``: توضیحات: `` نقش برای خروجی لاتکس.
جمع آوری TODO گره پس از کل سند به عنوان خوانده شده شده است. این اجازه می دهد تا با قرار دادن مراجع تعویض در موارد TODO.
آیا `` ارزش پیکربندی today`` صریح و روشن در ساخت لیتک نادیده بگیرد.
`` متن alt`` از نمودار ارث در حال حاضر بسیار پاک کن.
نادیده گرفتن تصاویر در عنوان بخش زمانی که تولید نوشتن شرح تصاویر و لینک کنید.
پیام های استثنا پشتیبانی در `` testoutput`` بلوک از `` پسوند doctest``.
بلوک خط به درستی در خروجی HTML مدل دهید.
نویسنده `` locale_dirs`` کار ارزش پیکربندی دوباره.
`` ارزش html_context`` داده شده در خط فرمان از طریق `` -A`` باید ارزش های دیگر داده شده در conf.py. باطل نیست
رفع اشکال جلوگیری از بازسازی افزایشی برای `` سازنده dirhtml``.
رفع mangling از نقل قول ها در برخی از بلوک اللفظی.
رفع مسیر به شاخص جستجو برای `` سازنده dirhtml``.
رفع مسئله سازگاری Jython: را وابستگی به `` ماژول parser`` اختیاری است.
در autodoc، گرفتن تمام خطاهایی که در واردات ماژول رخ می دهد، نه فقط `` ImportError``.
ثابت دست زدن به غیر داده، اما توصیف غیر روش در autodoc.
هنگام کپی کردن فایل بار، OSErrors مطرح شده توسط `` os.utime () `` را نادیده گرفت.
در مورد نیاز:
Pygments 1.2 یا بالاتر
Jinja 2.3 یا بالاتر
Docutils 0/7 یا بالاتر
نظر یافت نشد