Sphinx

Yazılım ekran görüntüsü:
Sphinx
Yazılım detaylar:
Versiyon: 1.3.1 Güncelenir
Qayıt: 12 May 15
Geliştirici: Georg Brandl
Lisans: Ücretsiz
Popülerlik: 54

Rating: nan/5 (Total Votes: 0)

İlk kez oluşturulan, bu ana amacı, Python 'ın kendi kodu için bir belge jeneratör gibi hizmet etmek oldu bu.
O zamandan beri, proje ne olursa olsun dil etrafında en otomatik belge jeneratörler en başvurulan etkilerden biri olan kalkınma dünyada kült statüsüne ulaşmıştır.
Bugün, sadece Python yanı sıra, Sfenks aynı zamanda C ve C ++ kodu ile kullanılabilir.

Bu sürümdeki yeni Nedir:

  • C ++ etki kolaylık direktif ve rolleri ekleyin: direktif `` cpp'nin: var`` cpp'de `` için takma ad olarak: member`` rolü ``: cpp: var`` `` için takma ad olarak: cpp'de: üye Herhangi bir C ++ declaraction çapraz başvuru için `` ve rol `any`.
  • : confval: `source_suffix` yapılandırma değeri artık birden eklerin listesi olabilir
  • .
  • ile kaynak sonek kaynak ayrıştırıcıları belirtmek için yeteneği ekleyin: confval:. `Source_parsers` yapılandırma değeri
  • Yeni bir oluşturucu, AppleHelpBuilder Apple Yardım Kitaplar inşa sözlerine ekledi edilmiştir.

sürümde yeni nedir 1.2.3 / 1.3b3:

  • Sfenks sürümü programlı kontrol etmek için `` sphinx.version_info`` başlığın eklendi.

sürüm 1.1.3 yeni Nedir:

  • Bazı ayarları ile Sabit kazası: confval:. `Modindex_common_prefix`
  • Python 3 -D`` `` ele alınması ve `` -A`` seçenekler düzeltildi.
  • Tanınan ve yerine yineleme hataları içine çalışan, dairesel toctrees hakkında uyarmak.
  • docutils gövde ile uyumluluk geri yükleyin.
  • Sabit HtmlHelp endeksi giriş bağlantıları tekrar.

  • Yerleşikleri üzerinde nitelik hataları yükselterek
  • Sabit inheritance_diagram.
  • Sabit çöküyor bir sözlüğü açıklamalarda veya yalnız terimleri koyarak.

  • Tüm Sfenks için
  • Sabit HTML yardım dili / kodlama haritalama desteklenen diller.

sürüm 1.1 yeni Nedir:

  • Özellikler ekledi:
  • Eklendi Python 3.x desteği.
  • Yeni inşaatçılar ve alt.
  • Uyumsuz değişiklikler:
  • : ilk: dir: `py: module` yönergesi artık onun` `platform`` seçenek değeri çıkışı yok. (Bu nedenle oldukça tutarsız yönerge çıkış yaptığı tek şey oldu, ve.)

  • Eski bağımlılık sürümleri için
  • kaldırıldı destek.
  • Yeni yerel ayarlar:
  • Eklenen İsveçli yerel.
  • Eklenen İran yerel.
  • Added Letonya yerel.
  • Eklenen Nepali yerel.
  • Koreli yerel eklendi.
  • Eklenen Estonya yerel.

sürüm 1.0.8 yeni Nedir:

  • autosummary nesil AttributeErrors için Fix tracebacks.

  • Kısaltma içinde satırsonu olduğunda
  • `` abbr`` rol sabitleyin.
  • özel nesne türleri ile arama sonuçlarına bağlantıları sabitleyin.

  • Tanımsız başvurular hakkında uyarılar rapor
  • Fix satır numaralarını.
  • adlarını yazmanız olmayan Fix C ++ dizi tanımları ve şablon argümanları.
  • LaTeX çıkışı bölüm başlıkları dipnotlar izin verin.
  • izin anahtar kelimeler intersphinx üzerinden bağlantı kurulacak.
  • üretim listesi belirteç adlarında Unicode karakterleri izin verin.
  • metin ve erkek için graphviz düğümleri için kukla ziyaretçi ekleyin.
  • Fix görüntü dosyası çoğaltma hata.

  • C ++ etki birden imza
  • Fix ayrıştırma.
  • kaynak dosyaları ararken Emacs kilit dosyaları yoksay.
  • AutoDoc içinde alınabilir modülleri için .pyw uzantısı izin verin.
  • kullan `` $ quickstart oluşturulan Makefile içinde (MARKA) ``.
  • tarayıcılarda kenar çubuğu arama kutusu genişliği tutarlı olun.

  • HTML çıktısında merkezli rakamların
  • Fix aralığı.
  • bunları yazdırırken Güvenle sys.stderr için SphinxError mesajları kodlamak.

  • Hiçbir bölümlü bir belgenin ancak bir bağlantı hedefi ile
  • Fix LaTeX çıktı hatası.
  • Doğru AutoDoc yöntemleri gibi yerleşik bir yöntem tanımlayıcıları davranın.
  • Python textwrap modülünü monkeypatching durdurun.
  • Viewcode şimdi ASCII olmayan kodlama var kaynak dosyaları ile düzgün çalışır.
  • py içinde `` noindex`` bayrak seçeneği Saygı:. Modül direktifleri

  • Birinci: dir: çizgiler varolmayan dahil
  • Fix IndexErrors. `Literalinclude`
  • Saygı özel işlevi / yöntem parametresi ayırıcı dizeleri.

  • JQuery & gt ile
  • Fix JS uyumsuzluğu;. = 1.5

  • HTMLHelp .hhk dosyaları yazarken
  • yapılan çift kodlama sabitleyin.
  • ayrıştırıldı-literal bloklarda smartypants uygulamayın.
  • C ++ alanı şimdi dizi tanımları destekler.

sürüm 1.0.6 yeni Nedir:

  • Boş çapraz başvuru hedefleri için Python etki Fix traceback.
  • Chrome tarayıcılarında literal blok görüntüleme sorunları düzeltin.
  • genel endeks ve sözlükte aksanlı karakterler, sınırlı sıralama Destek.
  • yerelin tercih kodlama ile -A`` komut satırı argümanları `` çözme -D`` ve `` deneyin.
  • gözlemleyin: confval:. `Locale_dirs` JS çevirileri dosyası ararken
  • LaTeX üreticisi Japon belgelerin daha iyi destek için özel bir kod ekleyin.

  • Param: tek `` ile verilen parametre varsa:
  • 77. regresyon. `Biçimlendirme, mermi listesi şimdi tekrar bastırılır
  • belirli durumlarda LaTeX çıktı paragraf sonlarını eksik Fix.
  • Bu içerik ekleyebilirsiniz böylece docstringe olmadan bile nesneler için `` AutoDoc-işlem-docstring`` olayı Emit.
  • LaTeX oluşturucu olarak, sadece edebi bloklar farklı tablo işlem gerektiren, ama aynı zamanda oldukça birkaç diğer liste benzeri blok elemanları.

  • Geçerli bir imza yok Python nesneleri için viewcode uzantısında
  • Fix tracebacks.
  • nedeniyle docutils sürümüne bağlı olarak farklı davranışları AutoDoc-dahil Docstringler, üretilen uyarılar için satır numaraları garip raporlamaların sabitleyin.
  • C ++ etki Çeşitli düzeltmeler.

sürüm 1.0.5 yeni Nedir:

  • hizalanmış görüntü ve figürlerin docutils 0.7 gerekli CSS stilleri ekleyin.

  • Makefile
  • Temiz üzerinde pdf dosyalarını silmeyin, LaTeX çıktı tarafından oluşturulan; Onlar görüntüleri gerekli olabilir.

  • Hat bloklar için oluşturulan
  • Fix LaTeX çıktı.
  • kaynak dosya uzantısı olarak .pyw`` `` izin verin.

sürüm 1.0.4 yeni Nedir:

  • sürüm 2 zlib sıkıştırılmış veriler içerdiğinden Windows binary modunda Açık intersphinx stokları.
  • JavaScript dosyaları için yerel olmayan URI'leri vererek izin örneğin JSMath uzantısı.
  • Fix traceback zaman `` intersphinx_mapping`` boştur.

sürüm 1.0.3 yeni Nedir:

  • docutils masa-of-içeriğinden gelen bağlantılar için dış bağlantı ayrım vs iç Fix.
  • için `` maxdepth`` seçeneği Fix `` toctree () `` şablon çağrılabilir `kullanıldığında` çöküşü = True``.
  • dize hazır olarak parantez içeren Python argüman listeleri ayrıştırma Fix kazasında.
  • Fix gerileme başlıkları yoktur rakamları ile LaTeX dokümanlar bina.
  • picklable olmayan sınıflar için Fix miras diyagramları.
  • daha kolay görmek için yapım, kenar çubuğu çöküşü düğmesi için ayrı arka plan rengini tanıtın.
  • birkaç yerleşik temalar.
  • küçük yerleşim hataları düzeltildi

sürüm 1.0.2 yeni Nedir:


    Func:
  • tarafından eklenen türleri nesnelere çapraz referansları Fix. `~ .Sphinx.add_object_type` API işlevi

  • Farklı yönerge türleri için doc alan türlerinden
  • Fix işleme.
  • Uzun imza kırılma boşluksuz kaçan satırsonu ile devam izin verin.
  • (çünkü Pygments stilleri ile bir ad çatışma) C alanı referanslar istenmeyen styling sabitleyin.
  • açık dübel ile KEP'lerde ve RFC başvurular izin verin.
  • rakamlara Fix LaTeX referanslar.
  • olmayan bir tam arama yapıyor, nesnenin maçı sadece verilen türü.
  • çok modüller için .name`` `` ile Python referans hedefleri olmayan kesin bir arama uygulayın.

  • Bir bilgi alan listesinde bir parametre çoğaltarak
  • Fix kazasında.
  • `` oldcmarkup`` uzantısı tarafından sağlanan bir varsayılan rolü ayarı sabitleyin.

  • Bir `` json`` modülü sağlar, ancak simplejson için uyumsuz json-py yüklü
  • Fix kazasında,.

  • Hedef intersphinx içinde adlandırma
  • Fix işleme.
  • `` arasında! `` Fix kaldırma tüm çapraz başvuru rolleri için.

sürüm 1.0.1 yeni Nedir:

  • geri kalanı etki alanı nesneleri için oluşturulan hedef isimleri Fix; Aynı ad değildir.
  • Bengalce dil ekleyin.
  • JavaScript nesne adları ayrıştırma bir hatayı düzeltin.
  • hiçbir toctree olduğunda SingleHTMLBuilder ile bina Fix.

  • Açık hedefler intersphinx tarafından bağlantılı nesneler için
  • Fix görünen adları.
  • JSON oluşturucu ile bina Fix.

  • LaTeX nesne açıklamalarında
  • Fix hyperrefs.

sürüm 1.0 yeni Nedir:

  • Genel:
  • tüm eksik başvuruları için uyarılar yayan bir "nitpicky" modunda eklendi. Seçeneği: `-n` komut satırı anahtarı veya: confval: Bu aktive edilir.` Nitpicky` yapılandırma değeri
  • hızlı başlangıç ​​eklendi `` latexpdf`` hedef Makefile.
  • Biçimlendirme:
  • : ilk: rol: `menuselection` ve: birinci: rol:.` Guilabel` roller artık işareti hızlandırıcıları destekleyen
  • Yeni daha kompakt doc alan sözdizimi artık kabul edilmektedir: ``: param tipi ismi:. Description``
  • `` Eklenenler sekme width`` seçenek: rst: dir. `Literalinclude` direktif
  • titlesonly`` seçeneği `` Eklendi: birinci: dir. `Toctree` direktifi

  • Birinci: dir:
  • `` append`` seçenekleri `` prepend`` eklendi ve. `Literalinclude` direktif
  • Tüm DOCINFO meta şimdi belge meta verileri içine konur, sadece yazar.
  • : ilk: rol: `ref` rol şimdi de başlığı ile tabloları başvurabilirsiniz
  • .
  • : ilk: dir. `De kapsayacak direktif artık kaynak dizinine göreli olarak yorumlanır mutlak yollarını destekler

  • Python etki alanında
  • `` gibi referanslar: func:. `Şimdi doğrudan eşleşme bulunursa, herhangi bir önek ile eşleşen adlarından bakmak .name```
  • Yapılandırma:
  • Eklendi: confval:. `Rst_prolog` yapılandırma değeri
  • Eklendi: confval:. `Bölüm numaralandırma formatını kontrol etmek html_secnumber_suffix` yapılandırma değeri
  • Eklendi: confval:. Docutils 'kompakt listeleri özelliği kontrol etmek için `html_compact_lists` yapılandırma değeri
  • : confval: `html_sidebars` yapılandırma değeri şimdi anahtarları gibi desenleri içerebilir ve değerler açıkça kenar çubuğu şablonları render gereken seçeneğini listeleri olabilir. Bu yerleşik kenar çubuğu içeriği sadece seçici dahil edilebilir anlamına gelir.
  • : confval:. `Html_static_path` şimdi tek dosya girişlerini içerebilir
  • Yeni evrensel yapılandırma değeri: confval: `exclude_patterns` eski yapar: confval:` unused_docs`: confval: `exclude_trees` ve: confval:.` Eski exclude_dirnames`
  • Eklendi: confval:. `Html_output_encoding` yapılandırma değeri

  • Confval:
  • Added `latex_docclass` yapılandırma değeri ve" oneside "tarafından geçersiz kılınabilir" twoside "documentclass seçeneği yapılan
  • .
    Confval:
  • eklendi. `Trim_doctest_flags` yapılandırma değeri, varsayılan olarak doğrudur
  • Eklendi: confval:. `Html_show_copyright` yapılandırma değeri
  • Eklendi: confval: `latex_show_pagerefs` ve: confval:.` Latex_show_urls` yapılandırma değerleri
  • davranışı: confval: `html_file_suffix` biraz değişti: boş bir dize yerine artık" default soneki "nin" hayır soneki "anlamına gelir kullanımını` `None``" default soneki "için
  • .
  • Yeni inşaatçılar:
  • Epub biçimi için bir kurucu eklendi.
  • manuel sayfaları için oluşturucu eklendi.
  • tek bir dosya, HTML oluşturucu eklendi.
  • HTML çıktısı:
  • Inline roller artık stilleri kendi görünümünü özelleştirmek için izin, kendi adını taşıyan bir CSS sınıfı olsun. Alana özgü rolleri iki sınıf, `` domain`` ve `` domain-rolename`` olsun.
  • Referanslar artık geçerli sayfaya iç aksine onlar, bütün proje için iç olan internal`` ise `` sınıf olsun.
  • Dış referanslar varsayılan tema için yeni `` externalrefs`` tema seçeneği ile farklı tarz olabilir.
  • varsayılan tema olarak, kenar çubuğu deneysel şimdi yeni `` collapsiblesidebar`` tema seçeneği kullanılarak katlanabilir yapılabilir.
  • Toctrees artık HTML çıktısında toctree-wrapper`` `` sınıfı ile `` div`` etiketi sarılır.
  • : veriler:. `Şablonları çağrılabilir şimdi üretilen ağacın derinliğini kontrol etmek için` `maxdepth`` kelime argüman vardır toctree`
  • : veriler:. `Şablonlar çağrılabilir şimdi` `titles_only`` kelime argümanı kabul toctree`

  • Düzen şablonu
  • Eklenenler `` htmltitle`` bloğu.
  • JavaScript aramada, sys.argv`` `` gibi, modül adı da dahil olmak üzere nesne adları için arama izin verir.
  • Haiku OS kullanıcı kılavuzunda esinlenerek yeni tema `` haiku``, eklendi.
  • Eklenen yeni tema `` nature``.
  • Andi Albrecht tarafından oluşturulan yeni tema `` agogo``, eklendi.
  • Armin Ronacher tarafından oluşturulan yeni tema `` scrolls``, eklendi.
  • varsayılan tema için `` visitedlinkcolor`` tema seçeneği eklendi.

  • Zaman uyumsuz theSearch endeksi yükleyerek
  • arama sayfasının Geliştirilmiş yanıt.
  • Uzatma API:
  • Eklendi: Olay:. `Html toplamak-pages`
  • Eklendi: confval: `needs_sphinx` yapılandırma değeri ve: met:.` ~ Sphinx.application.Sphinx.require_sphinx` uygulama API yöntemi
  • Eklendi: met:. `~ Sphinx.application.Sphinx.add_stylesheet` uygulama API yöntemi
  • Eklentiler:

  • Mod:
  • Added `~ sphinx.ext.viewcode` uzantısı
  • .
    Mod:
  • Added `~ sphinx.ext.extlinks` uzantısı
  • .
  • `ile AutoDoc üyelerin kaynağı sipariş için destek eklendi,` autodoc_member_order = 'bysource'``.
  • Eklendi: confval:. `Tüm AutoDoc direktifleri için varsayılan bayrakları seçmek için kullanılabilecek autodoc_default_flags` yapılandırma değeri,
  • intersphinx diğer projelerde adlı etiketlere başvurmak için, ve bağlanmak istediğiniz projeyi belirlemek için bir yol eklendi.

  • Şimdi örnek belge olabilir
  • AutoDoc __init__`` yöntemler `` atanmış öznitelikleri.
  • Birçok yenilik ve düzeltmeler: mod:. Pauli Virtanen için `~ sphinx.ext.autosummary` uzantısı, teşekkür
  • : mod: `~ sphinx.ext.graphviz` uzantısı olabilir confval tarafından kontrol yerine PNG görüntüleri artık çıkış SVG,:.` Graphviz_output_format` yapılandırma değeri
  • alt`` seçeneği `` Eklendi: rst: dir. `Graphviz` uzatma direktifleri
  • Eklenenler `` exclude`` argüman için: func:. `.autodoc.between`
  • Çeviriler:
  • Bojan Mihelac için, teşekkür Hırvat çeviri eklendi.
  • Fırat Özgül için, teşekkürler Türkçe çevirisi eklendi.
  • Eklendi Katalan çeviri, Pau Fernandez teşekkürler.
  • Eklenenler basitleştirilmiş Çince çeviri.
  • Hjorth Larsen için, teşekkür Danca çevirisi eklendi.
  • Dalius Dobravolskas için, teşekkür Litvanyalı çeviri eklendi.

sürüm 1.0b1 yeni Nedir:

  • etki için destek eklendi. Bir etki alanı direktifleri ve tüm nesneleri, örneğin birlikte aidiyet açıklayan rolleri bir koleksiyon Bir programlama dilinin elemanları. Birkaç yerleşik etki sağlanır: - Python - C - C ++ - JavaScript - reStructuredText
  • tanımlanması ve `` oldcmarkup`` uzantısı aktive olmadan artık işe yaramaz C direktiflerine bağlamak için eski biçimlendirme.

  • Eski bağımlılık sürümleri için
  • kaldırıldı destek.
  • kaldırıldı kaldırılmış elemanlar.

sürüm 0.6.5 yeni Nedir:

  • AutoDoc olarak, açıkça dokümantasyon yorumlarınıza kullanılarak belgelenen bazı modül üyelerinin ihmal sabitleyin.

  • Varsayılan tema stickysidebar`` seçeneği `` ile kenar çubuğu kaydırma çubuğu
  • Fix kırpma.
  • Her zaman hızlı başlangıç ​​Makefile UNIX satırsonu oluşturur.
  • Windows altında -C`` `` ile çalışan sabitleyin.
  • AutoDoc olarak, dahili mekanizma başarısız bir nesnenin imza özelleştirme izin verir.

  • LaTeX başlangıç ​​değerleri ile numaralandırılan listeler için
  • Fix çıktı.

  • Birlikte kullanılmadığı takdirde
  • Doğru `` literalinclude`` yönerge çalışmaları `` start-after`` ve `` son before`` seçenekleri yapın.
  • LaTeX üreticisi Fix bağlantısını nesil.

sürüm 0.6.4 yeni Nedir:

  • yapılandırmada Unicode olmayan dizeleri işleme Geliştirilmiş.

  • Anlamadığı argümanlarla graphviz çağrılırken
  • yakalamak OSErrors meydana.
  • Pygments & gt ile uyumluluk Restore;. = 1.2
  • LaTeX çıktı Hyperref hedeflerin kaçan sabitleyin.

  • Doc: `` tarafından oluşturulan
  • Fix bağlantıları. LaTeX çıkışı için `` rolü
  • tüm belge okunduktan sonra todo düğümleri toplayın; Bu todo öğeler ikame başvuruları yerleştirerek izin verir.
  • LaTeX yapı içinde açık `` today`` yapılandırma değerini göz ardı etmeyin.
  • miras diyagramları `` alt`` metin artık daha temiz.

  • Bağlantı başlıkları oluştururken
  • bölüm başlıkları görüntüleri Yoksay.

  • `` Doctest`` uzantısı `` testoutput`` bloklarında
  • Destek istisna mesajları.
  • Satır blokları HTML çıktısı düzgün tarz.

  • Tekrar `` locale_dirs`` yapılandırma değeri çalışması yapılmış
  • .
  • `` html_context`` değerleri -A`` conf.py verilen diğer değerleri geçersiz olmamalıdır `` yoluyla komut satırında verilen.
  • `` dirhtml`` üreticisi için artan rebuilds engelleyen bir hata düzeltildi.
  • Bazı edebi bloklarda tırnak bozma sabitleyin.

  • `` Dirhtml`` üreticisi arama indeksine
  • Fix yolu.
  • Jython uyumluluk sorunu Fix: İsteğe bağlı `` parser`` modülü bağımlılığı yapmak
  • .
  • AutoDoc olarak, modül ithalat sadece `` ImportError``.
  • meydana gelen tüm hataları yakalamak
    AutoDoc
  • olmayan verilerin işlenmesini Fix, ama non-yöntem tanımlayıcıları.

  • Dosya sürelerini kopyalarken
  • os.utime `` tarafından gündeme getirilen OSErrors () `` görmezden geliyor.

Gereksinimleri :

  • Pygments 1.2 veya üstü
  • Jinja 2.3 veya üstü
  • Docutils 0/7 veya üstü

Ekran

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

Benzer yazılım

Melkor
Melkor

13 May 15

askbot
askbot

12 May 15

PhpWiki
PhpWiki

10 Feb 16

Geliştirici Diğer yazılım Georg Brandl

Pygments
Pygments

14 Apr 15

Sphinx
Sphinx

14 Apr 15

Yorumlar Sphinx

Yorum Bulunamadı
Yorum eklemek
Görüntülerde açın!