Sphinx

ilk dəfə yaradılmış, o, əsas məqsədi Python 's öz kodu Sənədləşmə generator kimi xidmət etmək idi.
O vaxtdan bəri, layihə asılı olmayaraq dil ətrafında ən avtomatik sənədlər generatorları ən istinad təsir biri olan inkişaf dünyada dini statusu çatdı.
Bu gün yalnız Python yanaşı, Sphinx həmçinin C və C ++ kodu ilə istifadə oluna bilər.

Bu azad yeni nədir:

• C ++ etki rahatlığı direktivləri və rolları əlavə direktiv `` CPP: var`` CPP `` üçün takma kimi: member`` rolu ``: ABM: var`` `` üçün takma kimi: CPP: üzvü Hər hansı bir C ++ declaraction üçün cross-sened üçün `` və `rol any`.
• confval: `source_suffix` config dəyəri indi çox şəkilçilərin siyahısı ola bilər
.
• mənbə şəkilçi ilə qaynaq parsers müəyyən etmək imkanı əlavə confval. `Source_parsers` config dəyəri
• A yeni builder, AppleHelpBuilder, Apple Kömək Kitablar qurur ki, əlavə edilmişdir.

versiya yeni nədir 1.2.3 / 1.3b3:

• Sphinx versiyası proqram yoxlanılması üçün `` sphinx.version_info`` Tuple əlavə edib.

versiyası 1.1.3 yeni nədir:

• bəzi parametrləri ilə Sabit crash: confval. `Modindex_common_prefix`
• Python 3 -D`` `` rəftar və `` -A`` variantları Sabit.
• tanınan əvəzinə recursion səhvlər daxil çalışan, dairəvi toctrees barədə xəbərdarlıq.
• docutils gövdə ilə uyğunluğu bərpa edin.
• Sabit HTMLHelp index giriş links yenidən.

Builtins haqqında atributu səhvlər artırılması
• Sabit inheritance_diagram.
• Sabit qəzaları bir glossary ilə şərh və ya tək şərtləri qoyulması.

Bütün Sphinx üçün
• Sabit HTML help dil ​​/ encoding mapping dili dəstəklədiyi.

Version 1.1 yeni nədir:

• Features əlavə:
• Added Python 3.x dəstək.
• Yeni qurucuları və alt.
• gəlməyən dəyişikliklər:
• ilk: dir: `py: module` direktiv artıq öz` `platform`` seçim dəyər çıxış etmir. (Buna görə də, kifayət qədər ziddiyyətli direktiv çıxış etdi ki, yalnız bir şey idi, və s.)

Köhnə asılılıq versiyaları üçün
• silindi dəstək.
• Yeni locales:
• Əlavə İsveç yerli.
• Əlavə İran yerli.
• Əlavə Latviya yerli.
• Əlavə Nepali yerli.
• Koreya yerli Added.
• Əlavə Estoniya yerli.

versiyası 1.0.8 yeni nədir:

• autosummary nəsil AttributeErrors üçün Fix tracebacks.

Kısaltma bu səhifədə nəyi tapa biləcəksiniz zaman
• `` abbr`` rol Fix.
• xüsusi obyekt növləri ilə axtarış nəticələri bağlantılar Fix.

Undefined istinadlar haqqında xəbərdarlıq hesabat
• Fix xətt nömrələri.
• adlarını yazın deyil Fix C ++ array təriflər və şablon dəlilləri.
• lateks çıxdı bölmə başlıqlarını Dipnot imkan verir.
• izin ver açar sözlər intersphinx vasitəsilə bağlı ola bilər.
• istehsal siyahısı mö'cüzə adları Unicode simvol imkan verir.
• mətn və insan üçün Graphviz qovşaqlarının üçün dummy baxış əlavə edin.
• Fix image file təkrarlanması bug.

C ++ domen çox imza
• Fix təhlil.
• mənbə faylları axtarır zaman Emacs kilid faylları bilməz.
• AutoDoc da importable modulları üçün .pyw uzadılması imkan verir.
• İstifadə `` $ quickstart yaradıldı Makefiles in (BU) ``.
• brauzerlərdə sidebar axtarış qutusu eni ardıcıl olun.

HTML çıxdı mərkəzi rəqəmlər
• Fix spacing.
• onları çap zaman təhlükəsiz sys.stderr üçün SphinxError mesaj kodlar.

Heç bir bölmələri ilə bir sənəd, lakin link hədəf
• Fix lateks çıxış səhv.
• Düzgün AutoDoc üsullar kimi daxili üsulu descriptors müalicə.
• Python textwrap modulu monkeypatching Stop.
• Viewcode qeyri-ASCII encoding var mənbə faylları ilə düzgün işləyir.
• py da `` noindex`` bayraq seçimi hörmət. Modul direktivləri

Birinci: dir: xətləri nonexisting, o cümlədən
• Fix IndexErrors. `Literalinclude`
• Respect xüsusi funksiyası / metodu parametr separator strings.

JQuery və GT ilə
• Fix JS uyğunsuzluq. = 1,5

HTMLHelp .hhk faylları yazarkən
• görülən ikiqat encoding Fix.
• ayrıştırılan-hərfi blokları Smartypants tətbiq etməyin.
• C ++ domain indi sıra anlayışlar dəstəkləyir.

versiyası 1.0.6 yeni nədir:

• boş cross-reference hədəfləri üçün Python sahəsində Fix traceback.
• Chrome brauzerlər hərfi blok ekran məsələləri Fix.
• general indeksi və glossary accented simvol məhdud sıra çeşidlənməsi Support.
• Yerli üstünlük kodlama ilə -A`` komanda-line dəlilləri `` decoding -D`` və `` edin.
• Müşahidə: confval. `Locale_dirs` JS tərcümə faylı axtarır zaman
• lateks builder Yapon sənədlərin daha yaxşı dəstək üçün xüsusi kodu əlavə edin.

Param: yalnız bir `` ilə verilən parametr varsa:
• # 77 Regression. `` Biçimlendirme, güllə siyahısı indi yenidən yatırıldı
• Bəzi hallarda lateks çıxış paraqraf fasilələri itkin Fix.
• Bu məzmun əlavə edə bilərsiniz ki, bir docstring olmadan da obyektlər üçün `` AutoDoc-proses docstring`` hadisə buraxmaq.
• lateks inşaatçı, yalnız hərfi blokları müxtəlif masa rəftar tələb edir, həm də bir neçə digər siyahısı kimi blok elementləri.

Etibarlı imza yoxdur Python obyektlərin viewcode uzadılması
• Fix tracebacks.
• görə docutils versiyası asılı olaraq müxtəlif davranış AutoDoc-daxil docstrings, yaranan xəbərdarlıq üçün line nömrələri qəribə reportajlar Fix.
• C ++ domain bir neçə düzeltmelerini.

versiyası 1.0.5 yeni nədir:

• uyğun şəkillər və rəqəmlər üçün docutils 0.7 tələb olunan CSS üslub əlavə edin.

Makefile ildə
• təmiz pdf faylları silmeyin, lateks çıxdı tərəfindən; Onlar şəkillər tələb oluna bilər.

Line blokları üçün yaradılan
• Fix lateks çıxdı.
• mənbəyi fayl uzantısı kimi .pyw`` `` imkan verir.

versiyası 1.0.4 yeni nədir:

• version 2 zlib-sıxılmış data ehtiva edir-ci ildən Windows ikili rejimində Açıq intersphinx ehtiyatlar.
• JavaScript fayllar üçün qeyri-yerli URI'ler verilməsi imkan verir, məsələn, JSMath uzadılması.
• Fix traceback zaman `` intersphinx_mapping`` boşdur.

Versiya 1.0.3 yeni nədir:

• bir docutils masa-of-məzmunu gələn bağlantıları üçün xarici link fərq vs daxili Fix.
• üçün `` maxdepth`` seçimi Fix `` toctree () `` şablon callable `istifadə edərkən` dağılması = True``.
• string literator Mötərizədə olan Python dəlil siyahıları təhlil Fix crash.
• Fix reqressiya mövzular yoxdur xadimləri ilə lateks docs bina.
• picklable deyil siniflər üçün Fix miras diaqramları.
• daha asan görmək edilməsi, sidebar dağılması düyməsini ayrı fon rəngi təqdim edir.
• neçə daxili mövzular.
kiçik layout hatalar Fix

versiyası 1.0.2 yeni nədir:

Func:
• əlavə növləri obyektlərinə cross-istinadlar Fix. `~ .Sphinx.add_object_type` API funksiyası

Müxtəlif direktiv növləri üçün doc sahə növ
• Fix user.
• uzun imza qırılma boşluq-qaçan newlines davam imkan verir.
• (çünki Pygments üslub ilə bir ad toqquşma) C domain istinadlar istenmeyen üslubu Fix.
• açıq Çapa ilə Peps və RFCs istinadlar imkan verir.
• rəqəmlərə Fix lateks istinadlar.
• qeyri-dəqiq axtarış edir, obyektin matçda yalnız verilmiş növü.
• çox modulları üçün .name`` `` ilə Python istinad hədəfləri qeyri-dəqiq axtarış edin.

Bir info sahəsində siyahısında parametri çoxaldaraq
• Fix crash.
• `` oldcmarkup`` uzadılması ilə təmin bir default rol qəbulu Fix.

Bir `` json`` modulu təmin lakin simplejson üçün uyğun deyil json-py yüklü
• Fix crash.

Hədəf intersphinx adların verilməsi ilə bağlı
• Fix user.
• `` ın! `` Fix aradan qaldırılması bütün cross-reference rolu.

versiyası 1.0.1 yeni nədir:

• Rest domen obyektlər üçün yaradılan hədəf adları Fix; Eyni ad deyil.
• Benqal dili əlavə edin.
• JavaScript obyekt adları təhlil bir səhv düzelt.
• heç bir toctree olduqda SingleHTMLBuilder ilə bina Fix.

Açıq hədəfləri ilə intersphinx ilə bağlı obyektlər üçün
• Fix ekran adları.
• JSON builder ilə bina Fix.

Lateks üçün obyekt şərhlərində
• Fix hyperrefs.

1.0 versiyasını yeni nədir:

• Ümumi:
• Bütün itkin referanslar üçün xəbərdarlıq saçır bir "nitpicky" rejimi əlavə edilib. Seçimi: `-n` command-line keçid və ya: confval: Bu aktivləşdirilib.` Nitpicky` config dəyəri
• QUICKSTART əlavə `` latexpdf`` hədəf Makefile.
• Markup:
• ilk: rolu: `menuselection` və: birinci: rolu.` Guilabel` rolları indi işareti sürətləndirən dəstək
• Yeni daha yığcam doc sahədə syntax indi tanınır: ``: param növü adı. Description``
• `` əlavə etmək tab-width`` seçimi: RST: dir. `Literalinclude` direktiv
• titlesonly`` seçimi `` Added: birinci: dir. `Toctree` direktiv

Birinci: dir
• üçün `` append`` variantları `` prepend`` əlavə və. `Literalinclude` direktiv
• Bütün docinfo metadata artıq sənəd metadata daxil edilir, yalnız müəllifidir.
• ilk: rolu: `ref` rolu indi də mövzu ilə masalar istinad edə bilər
.
• ilk: dir. `Include` direktiv indi mənbə kataloq nisbətən kimi şərh olunur mütləq yolları dəstəkləyir

Python domen ildə
• `` kimi istinadlar: FUNC. `Indi birbaşa matç halda hər hansı bir prefiks ilə adları uyğun üçün baxmaq .name```
• Konfiqurasiya:
• Added: confval. `Rst_prolog` config dəyəri
• Added: confval. `Bölmə sayı format nəzarət html_secnumber_suffix` config dəyəri
• Added: confval. Docutils kompakt siyahıları xüsusiyyət nəzarət `html_compact_lists` config dəyəri
• confval: `html_sidebars` config dəyəri indi düymələri kimi nümunələri ola bilər, və dəyərlər aydın sidebar şablonları göstərilməlidir seçə siyahıları ola bilər. Bu builtin sidebar məzmunu yalnız seçilmiş daxil edilə bilər.
• confval. `Html_static_path` indi bir fayl entries ola bilər
• Yeni universal config dəyər: confval: `exclude_patterns` old edir: confval:` unused_docs`: confval: `exclude_trees` və: confval.` Köhnəlmiş exclude_dirnames`
• Added: confval. `Html_output_encoding` config dəyəri

Confval:
• Əlavə `latex_docclass` config dəyər və" oneside "tərəfindən overridable" twoside "documentclass seçimi etdi
.
Confval:
• Added. `Trim_doctest_flags` config dəyəri ismarıcları doğru
• Added: confval. `Html_show_copyright` config dəyəri
• Added: confval: `latex_show_pagerefs` və: confval.` Latex_show_urls` config dəyərlər
• davranış: confval: `html_file_suffix` qədər dəyişib: boş string indi əvəzinə" default şəkilçi "və" heç bir şəkilçi "deməkdir, istifadə` `None``" default şəkilçi "üçün
.
• Yeni qurucuları:
• Epub formatı üçün bir builder əlavə edib.
• manual pages üçün bir builder əlavə edib.
• bir fayl HTML builder əlavə edib.
• HTML çıxış
• Inline rolları indi üslub onların görünüşünü özelleştirmek üçün imkan verir, onların adı ilə CSS sinif almaq. Domain xüsusi rolu iki sinif, `` domain`` və `` domain-rolename`` almaq.
• References artıq cari səhifə daxili qarşı onlar bütün layihə daxili var internal`` əgər `sinif` almaq.
• Xarici istinadlar default mövzu üçün yeni `` externalrefs`` mövzu seçimi ilə fərqli səpkili bilər.
• default mövzu, sidebar təcrübi yeni `` collapsiblesidebar`` tema et istifadə edərək, qatlama edilə bilər.
• Toctrees indi HTML çıxdı toctree-wrapper`` `` sinif bir `` div`` tag bükülüb.
• data. `Şablonları callable indi yaradılan ağac dərinliyi nəzarət etmək üçün bir` `maxdepth`` söz dəlil var toctree`
• data. `Şablonları callable indi` `titles_only`` söz dəlil qəbul toctree`

Layout şablon
• Əlavə `` htmltitle`` blok.
• JavaScript axtarış, sys.argv`` `` kimi, modul adı, o cümlədən obyekt adları üçün axtarış imkan verir.
• Haiku OS istifadəçi təlimatına ilham yeni mövzu `` haiku``, əlavə edib.
• yeni mövzu `` nature``.
• Andi Albrecht yaratdığı yeni mövzu `` agogo``, əlavə edib.
• Armin Ronacher yaratdığı yeni mövzu `` scrolls``, əlavə edib.
• default mövzu bir `` visitedlinkcolor`` mövzu seçimi əlavə edilib.

Asynchronously thesearch indeksi loading tərəfindən
• Axtarış səhifənin Təkmilləşdirilmiş cavab.
• Daxili API
• Added: hadisə. `Html-toplamaq-pages`
• Added: confval: `needs_sphinx` config dəyəri və: met.` ~ Sphinx.application.Sphinx.require_sphinx` proqram API telefon
• Added: met. `~ Sphinx.application.Sphinx.add_stylesheet` proqram API telefon
• Extensions:

Mod:
• Əlavə `~ sphinx.ext.viewcode` uzadılması
.
Mod:
• Əlavə `~ sphinx.ext.extlinks` uzadılması
.
• `ilə AutoDoc üzv mənbəyi sifariş üçün əlavə dəstək,` autodoc_member_order = 'bysource'``.
• Added: confval. `Bütün AutoDoc direktivləri üçün default bayraqları seçmək üçün istifadə edilə bilər autodoc_default_flags` config dəyəri
• intersphinx digər layihələrdə adlı yazıları müraciət və keçid istəyirəm layihə müəyyən etmək üçün bir yol əlavə edib.

İndi instansiya sənəd bilər
• AutoDoc __init__`` üsulları `` təyin atributları.

Üçün
• Bir çox təkmilləşdirilməsi və giderir: mod. Pauli Virtanen üçün `~ sphinx.ext.autosummary` uzadılması sayəsində
• mod: `~ sphinx.ext.graphviz` uzadılması bilərsiniz confval tərəfindən nəzarət əvəzinə PNG images indi çıxış SVG:.` Graphviz_output_format` config dəyəri
• alt`` seçimi `` Added: RST: dir. `Graphviz` məsləhət direktivləri
• Əlavə `` exclude`` dəlil üçün: FUNC. `.autodoc.between`
• Translations:
• Bojan Mihelac sayəsində Xorvat tərcümə edib.
• Fırat Özgül sayəsində Türk tərcümə edib.
• Added Katalan tərcümə, Pau Fernandez sayəsində.
• Əlavə sadələşdirilmiş Çin tərcümə.
• Hjorth Larsen sayəsində Danimarka tərcümə edib.
• Dalius Dobravolskas sayəsində Litva tərcümə edib.

version 1.0b1 yeni nədir:

• alanlar üçün Support əlavə edilmişdir. A domen direktivləri və bütün obyektlərin, məsələn, birlikdə aid təsvir rolu toplusudur bir proqramlaşdırma dili elementləri. Bir neçə builtin domains təmin olunur: - Python - C - C ++ - JavaScript - reStructuredText
• müəyyənləşdirilməsi və `` oldcmarkup`` uzadılması Aktivləşdirmə olmadan artıq işləməyəcək C direktivləri keçid üçün köhnə biçimlendirme.

Köhnə asılılıq versiyaları üçün
• silindi dəstək.
• silindi deprecated elementləri.

versiyası 0.6.5 yeni nədir:

• AutoDoc ildə açıq sənədlər şərh istifadə sənədləşdirilmiş bir modul üzvlərinin səhv düzeltmek.

Default mövzu stickysidebar`` seçimi `` ilə sidebar gedin bar
• Fix əkin.
• Always quickstart Makefile da UNIX səhifədə nəyi tapa biləcəksiniz yaratmaq.
• Windows altında -C`` `` çalışan Fix.
• AutoDoc ildə daxili mexanizm uğursuz bir obyekt imza özelleştirmeye imkan verir.

Lateks start dəyərləri ilə sadalanan siyahıları üçün
• Fix çıxdı.

Birlikdə istifadə əgər
• düzgün `` literalinclude`` direktiv işə `` start-after`` və `` son before`` variantları olun.
• lateks builder Fix link nəsil.

versiyası 0.6.4 yeni nədir:

• konfiqurasiya qeyri-Unicode strings idarə Təkmilləşdirilmiş.

Bu anlamır dəlilləri ilə Graphviz zəng zaman
• Catch OSErrors baş.
• Pygments və GT ilə uyğunluğu bərpa. = 1,2
• lateks çıxdı hyperref hədəfləri qaçan Fix.

Doc: `` tərəfindən
• Fix links. Lateks çıxış üçün `` rolu
• bütün sənəd oxumaq sonra todo qovşaqlarının toplamaq; Bu todo maddələr əvəz istinadlar yerləşdirilməsi imkan verir.
• Bir lateks build bir açıq `` today`` config dəyəri ignore etməyin.
• miras diaqramları `` alt`` mətn indi daha təmiz edir.

Link mövzular oluştururken
• bölmə adları şəkillər bilməz.

`` Doctest`` uzadılması `` testoutput`` blokları
• Support istisna messages.
• Line blokları HTML çıxış düzgün səpkili olunur.

Yenidən `` locale_dirs`` config dəyəri çalışması etdi
• .
• `` html_context`` dəyərlər -A`` conf.py verilən digər dəyərlər yalnış olmaz `` vasitəsilə command line verilir.
• `` dirhtml`` builder üçün əlavə Bərpa qarşısını bir səhv Fix.
• Bəzi hərfi blokları quotes mangling Fix.

`` Dirhtml`` builder üçün axtarış index
• Fix yol.
• bir Jython uyğunluğu məsələ Fix: isteğe `` parser`` modulu asılılığı etmək
.
• AutoDoc olaraq, modul idxalına yalnız `` ImportError``.
baş verən bütün səhvlər tutmaq
AutoDoc da
• Qeyri-data user Fix, lakin qeyri-üsul descriptors.

Fayl dəfə çıxarmaq zaman
• os.utime `` qaldırdığı OSErrors () `` bilməz.

tələblər

• Pygments 1.2 və ya daha yüksək
• Jinja 2.3 və ya daha yüksək
• Docutils 0/7 və ya daha yüksək