Sphinx

Ce este nou în această versiune:

• Adăugați directive confort și rolurile domeniului C ++: directivă `` cpp: var`` ca alias pentru `` cpp: member``, rol ``: CPP: var`` ca alias pentru ``: cpp: membru ``, iar rolul `any` pentru eco-trimitere la orice C ++ declaratie.
• : confval: `valoare config source_suffix` poate fi acum o listă cu mai multe sufixe
.
• Adăugați capacitatea de a specifica sursa de interpretoare sufixul sursa cu: confval:. `Valoare config source_parsers`
• O nouă constructor, AppleHelpBuilder, a fost adăugată, care se bazează de Apple Ajutor Cărți.

Ce este nou în versiunea 1.2.3 / 1.3b3:

• Adaugata `` sphinx.version_info`` tuplu pentru verificarea programatică a versiunii Sphinx.

Ce este nou în versiunea 1.1.3:

• crash fixe cu unele setări de: confval:. `Modindex_common_prefix`
• fix manipularea `` `` -D`` și opțiuni -A`` pe Python 3.
• Recunoscut și avertizează cu privire la toctrees circulare, în loc de a rula în erorile de recursivitate.
• Restaurare compatibilitatea cu docutils trunchi.
• HtmlHelp legături de intrare index fixe din nou.
• inheritance_diagram fixă ​​creșterea erori de atribute pe afi.
• accidente fixe atunci când punerea comentarii sau termeni singuri într-un glosar.
• ajutor HTML fixă ​​cartografiere limba / codare pentru toate Sphinx sprijinit limbi.

Ce este nou în versiunea 1.1:

• Caracteristici adăugat:
• suport 3.x Adăugat Python.
• Noi constructori și subsistemului.
• schimbări incompatibile:
• : rst: dir: `Py: directivă module` nu mai are ieșire` `valoarea opțiunii platform``. (Acesta a fost singurul lucru pe care directiva a făcut ieșire, și, prin urmare, destul de inconsistente.)
• suport Eliminat pentru versiunile mai vechi de dependență.
• locales noi:
• Adaugata locale suedeză.
• Adaugata locale iranian.
• Adaugata locale letonă.
• Adaugata locale nepaleză.
• Adaugata coreeană locale.
• Adaugata locale estonian.

Ce este nou în versiunea 1.0.8:

• tracebacks Fix pentru AttributeErrors din generație autosummary.
• Fix `` abbr`` rolul atunci când prescurtarea are rânduri libere în el.
• Fix link-urile pentru a căuta rezultate cu tipuri de obiecte personalizate.
• numerele de linie Fix raportate în avertismente despre referințe nedefinite.
• Fix C ++ definiții matrice și argumente șablon care nu sunt de tip nume.
• Permiteți notele de subsol din anteturile sectiunea producției LaTeX.
• Permiteți cuvinte cheie pentru a fi legate prin intersphinx.
• Permiteți caractere Unicode în Lista de producție nume simbolice.
• Adauga vizitatori fictive pentru noduri Graphviz pentru text și om.
• bug Fix imagine fișier duplicarea.
• Fix parsarea de semnături multiple in domeniul C ++.
• Ignore fișiere de blocare Emacs atunci când caută fișierele sursă.
• Permiteți prelungire .pyw pentru module la import în AutoDoc.
• Utilizați `` $ (face) `` în generat-QuickStart Makefiles.
• Asigurați-sidebar lățime casetă de căutare consistentă în browsere.
• distanța Fix figurilor centrate în producția HTML.
• codifica în siguranță mesaje SphinxError atunci când le imprimați la sys.stderr.
• eroare de ieșire Fix LaTeX cu un document fără secțiuni, dar o țintă link.
• corect trata descriptori metoda built-in ca metode AutoDoc.
• Nu mai monkeypatching modulul textwrap Python.
• Viewcode acum funcționează corect cu fișierele sursă care au codificare non-ASCII.
• Respect `` opțiunea pavilion noindex`` în Py:. Directivele module
• IndexErrors Fix când inclusiv inexistente linii cu: rst: dir:. `Literalinclude`

Siruri de caractere
• funcții Respect personalizat / metodă parametru separator.
• incompatibilitate Fix JS cu jQuery & gt;. = 1,5
• Fix codificare dublă făcut la scrierea HTMLHelp .hhk fișiere.
• Nu aplicați Smartypants în blocuri-literale parsate.
• domeniu C ++ suportă acum definiții matrice.

Ce este nou în versiunea 1.0.6:

• Fix traceback in domeniul Python obiective eco-referință goale.
• Fix probleme de afișare bloc literale pe browserele Chrome.
• Suport de sortare o gamă limitată de caractere accentuate, în indicele general și glosar.
• Încercați decodare `` `` -D`` și argumente în linia de comandă -A`` cu codare preferat localizare a.
• Observați: confval:. `Locale_dirs` atunci când caută fișierul traduceri JS
• Adăugați cod special pentru o mai bună susținere a documentelor japoneze în constructor LaTeX.
• regresie de # 77: Dacă există un singur parametru dat cu ``: param:. `` Markup, lista bullet acum suprimată din nou
• Fix lipsește pauze de paragraf în producția LaTeX în anumite situații.
• Emiterea `` evenimentul AutoDoc-proces-docstring`` chiar și pentru obiecte fără docstring, astfel încât să puteți adăuga conținut.
• În constructor LaTeX, nu numai blocuri literale necesita manipulare masă diferite, dar, de asemenea, destul de multe alte-lista ca elemente ale blocului.
• tracebacks Repara în extinderea viewcode pentru obiectele Python care nu au o semnătură validă.
• Fix raportări ciudate de numere de linie de avertismente generate de docstrings inclus-AutoDoc, din cauza comportamentului diferit, în funcție de versiunea docutils.
• Mai multe remedieri pentru domeniul C ++.

Ce este nou în versiunea 1.0.5:

• Adăugați stiluri CSS cerute de docutils 0.7 pentru imagini aliniate și cifre.
• În Makefile generat de ieșire LaTeX, nu șterge fișierele PDF de pe curat; acestea ar putea fi necesară imagini.
• ieșire Fix LaTeX generat pentru blocuri de resort.
• Permiteți `` .pyw`` ca o extensie de fișier sursă.

Ce este nou în versiunea 1.0.4:

• Deschideți stocurilor intersphinx în modul binar pe Windows, deoarece versiunea 2 conține date comprimate-zlib.
• Permiteți da URI non-locale pentru fișiere JavaScript, de exemplu, în prelungirea JSMath.
• Fix traceback când `` intersphinx_mapping`` este gol.

Ce este nou în versiunea 1.0.3:

• Fix intern vs. distincție link extern pentru link-uri care provin de la un docutils masă de-conținut.
• Fix `` opțiunea maxdepth`` pentru `` toctree () `` șablon nevărsat, atunci când este utilizat cu `` colaps = True``.
• crash Fix analiză listele argumente Python conțin paranteze în șir literal.
• regresie Fix atunci când construirea docs LaTeX cu cifre care nu au legende.
• Fix diagrame mostenire pentru clase care nu sunt picklable.
• Introducerea culoarea de fundal separat pentru butonul colaps bara laterală, ceea ce face mai ușor pentru a vedea.
• Fix bug-uri mici de aspect în mai multe built-in teme.

Ce este nou în versiunea 1.0.2:

• Fix referințe încrucișate la obiecte de tipuri adăugate prin: FUNC:. `~ Funcția API .Sphinx.add_object_type`
• Manipularea Fix de tipuri de teren doc pentru diferite tipuri de directiva.
• Permiteți rupere semnături lungi, continuând cu liniile scăpat-backlash.
• Fix styling nedorit de C referințe domeniu (din cauza unui conflict cu namespace stiluri Pygments).
• Permiteți referințele la PEP și RFC cu ancore explicite.
• trimiteri Fix LaTeX la cifre.
• Când a face o căutare non-exactă, meci doar tipul dat de obiect.
• Aplicați căutare non-exactă pentru obiective de referință Python cu `` .name`` pentru module de asemenea.
• crash Fix atunci când duplicarea un parametru într-o listă domeniu info.
• Fix setarea rolul implicit unul furnizate de `` extensia oldcmarkup``.
• crash Fix atunci când este instalat JSON-py, care oferă o `` modul json``, dar este incompatibil de a simplejson.
• Manipularea Fix țintă numire în intersphinx.
• îndepărtarea Fix de ``! `` Pentru toate rolurile eco-referință.

Ce este nou în versiunea 1.0.1:

• Fix nume țintă generate de odihnă obiecte de domeniu; ele nu sunt în aceeași namespace.
• Adăugați limba bengali.
• Fix un bug în parsarea nume de obiecte JavaScript.
• Fix clădire cu SingleHTMLBuilder atunci când nu există nici o toctree.
• nume de afișare Fix pentru obiectele legate de prin intersphinx cu obiective explicite.
• Fixați clădire cu constructorul JSON.
• hyperrefs Repara în descrieri obiect pentru LaTeX.

Ce este nou în versiunea 1.0:

• General:
• Adăugat modul "nitpicky" care emite avertismente pentru toate trimiterile lipsesc. Acesta este activat de: optiunea: `-n` comutatorul de linie de comandă sau: confval:.` Nitpicky` valoarea config
• Adaugata `` țintă latexpdf`` în QuickStart Makefile.
• Markup:
• : rst: Rolul: `menuselection` și: rst: Rolul:.` Roluri guilabel` sprijini acum acceleratoare ampersand
• New sintaxa domeniu doc ​​mai compact este acum recunoscut: ``: nume de tip de param. Description``
• Adaugata `` optiune tab width`` la: rst: dir:. `Directivă literalinclude`
• Adaugata `` opțiune titlesonly`` la: rst: dir:. `Directivă toctree`
• Adaugata `` `` prepend`` și opțiuni append`` la: prima: dir:. `Directivă literalinclude`
• Toate docinfo metadate este acum pus în metadatele documentului, nu doar autorul.
• : rst: Rolul: `rol ref` pot acum, de asemenea, de referință tabele de legendă
.
• : rst: dir:. `Directivă include` suporta acum căi absolute, care sunt interpretate ca relativ la directorul sursă
• În domeniul Python, referințele ca ``: FUNC:. `.name``` Uita acum pentru potrivirea nume cu orice prefix dacă nu se potrivesc directă găsite
• Configurare:
• Adaugat: confval:. `Valoare config rst_prolog`
• Adaugat: confval:. `Valoare html_secnumber_suffix` config pentru a controla format numerotare secțiunea
• Adaugat: confval:. `Valoare html_compact_lists` config pentru a controla listele compacte docutils" dispun
• : confval: `html_sidebars` valoare config poate conține acum modele ca cheile, iar valorile pot fi liste care selectează în mod explicit care ar trebui să devină modele sidebar. Asta înseamnă că conținutul bara laterală builtin comanda pot fi incluse doar selectiv.
• : confval:. `Html_static_path` poate conține acum intrări de fișiere simple
• Noua valoare config universal: confval: `exclude_patterns` face vechi: confval:` unused_docs`,: confval: `exclude_trees` și: confval:.` Exclude_dirnames` învechit
• Adaugat: confval:. `Valoare config html_output_encoding`
• adaugarii: confval: `valoarea config latex_docclass` și a făcut" twoside "opțiune documentclass supracomandabile de" oneside "
.
• adaugarii: confval:. `Valoarea config trim_doctest_flags`, ceea ce este adevărat în mod implicit
• Adaugat: confval:. `Valoare config html_show_copyright`
• Adaugat: confval: `latex_show_pagerefs` și: confval:.` Valori de configurare latex_show_urls`
• Comportamentul: confval: `html_file_suffix` modificat ușor: șirul gol înseamnă acum" nu sufixul "în loc de" default sufixul ", utilizarea` `None`` pentru" sufixul default "
.
• Noi constructori:
• Adăugat un constructor pentru formatul Epub.
• Adăugat un constructor de pagini de manual.
• Adăugat un HTML constructor singur fișier.
• de ieșire HTML:

Rolurile
• Inline obține acum o clasa CSS cu numele lor, permițând stiluri de a personaliza aspectul lor. Rolurile specifice domeniului obține două clase, `` `` domain`` și domeniu de rolename``.
• Referinte obține acum clasa `` internal`` dacă acestea sunt interne întregul proiect, spre deosebire de interne la pagina curentă.
• referințe externe pot fi stil diferit cu noul `` opțiune temă externalrefs`` pentru tema implicită.
• În tema implicită, bara laterală poate experimental acum face pliabil folosind noul `` optiune collapsiblesidebar`` tema.
• Toctrees sunt acum înfășurat într-o `` div`` tag cu clasa de `` toctree-wrapper`` producției HTML.
• : Datele:. `Toctree` nevărsat în șabloane are acum o` `argument cuvinte cheie maxdepth`` pentru a controla adâncimea arborelui generat
• : Datele:. `Toctree` nevărsat în șabloane acceptă acum un` `argument cheie titles_only``
• Adaugata `` bloc htmltitle`` in template aspect.
• În căutarea JavaScript, permite căutarea numelor de obiecte, inclusiv numele modulului, ca `` sys.argv``.
• Adăugat nouă temă `` haiku``, inspirat de ghidul haiku OS.
• Adaugata temă nouă `` nature``.
• Adăugat nouă temă `` agogo``, creat de Andi Albrecht.
• Adăugat nouă temă `` scrolls``, creat de Armin Ronacher.
• Adaugata o `` opțiune temă visitedlinkcolor`` la tema implicită.
• reacție îmbunătățită a paginii de căutare de încărcare thesearch index asincron.
• API extensie:
• adaugarii: eveniment:. 'Html-collect-pages`
• Adaugat: confval: `valoare config needs_sphinx` și: met.` ~ Metodă sphinx.application.Sphinx.require_sphinx` cererea API
• Adaugat: met. `~ Metodă sphinx.application.Sphinx.add_stylesheet` cererea API
• Extensii:
• adaugarii: MOD: `~ extensie sphinx.ext.viewcode`
.
• adaugarii: MOD: `~ extensie sphinx.ext.extlinks`
.
• Adăugat suport pentru sursa comanda de membri în AutoDoc, cu `` autodoc_member_order = 'bysource'``.
• Adaugat: confval:. `Autodoc_default_flags` valoare config, care poate fi folosit pentru a selecta steaguri implicite pentru toate directivele AutoDoc
• Adăugat o modalitate pentru intersphinx să se refere la etichete cu numele in alte proiecte, precum și pentru a specifica proiectul pe care doriți să se leagă de.
• AutoDoc pot documenta acum exemplu atribute alocate în `` metodele __init__``.
• Numeroase îmbunătățiri și stabilește la: MOD:. `~ Extinderea sphinx.ext.autosummary`, datorită Pauli Virtanen
• : Mod: `~ prelungire sphinx.ext.graphviz` poate SVG acum de ieșire în loc de imagini PNG, controlat de confval:.` Valoare config graphviz_output_format`
• Adaugata `` opțiune alt`` la: rst: dir:. `Directive extensie graphviz`
• Adaugata `` argument exclude`` la: FUNC:. `.autodoc.between`
• Traduceri:
• Adăugat traducere croată, datorită Bojan Mihelac.
• Adăugat traducere turcă, datorită Firat Ozgul.
• traducere Adaugat catalană, datorită Pau Fernandez.
• Adaugata simplificată traducere chineză.
• Adăugat traducere daneză, datorită HJORTH Larsen.
• Adăugat traducere lituaniană, datorită Dalius Dobravolskas.

Ce este nou în versiunea 1.0b1:

• Suport pentru domenii a fost adaugat. Un domeniu este o colecție de directive și roluri care toate descriu obiectele aparținând împreună, de exemplu, elemente ale unui limbaj de programare. Câteva domenii builtin sunt furnizate: - Python - C - C ++ - JavaScript - reStructuredText
• vechi marcare pentru definirea și conectarea la directivele C nu va mai funcționa fără activarea `` extensia oldcmarkup``.
• suport Eliminat pentru versiunile mai vechi de dependență.
• elemente depreciate eliminate.

Ce este nou în versiunea 0.6.5:

• În AutoDoc, fixa omiterea unor membri module documentate în mod explicit, folosind comentarii documentație.
• Fix trunchiere de bara laterală bara de defilare cu `` opțiunea stickysidebar`` din tema implicită.
• genera întotdeauna liniile UNIX în Makefile QuickStart.
• Fix rulează cu `` -C`` sub Windows.
• În AutoDoc, permite personalizarea semnarea unui obiect în cazul în care mecanismul de built-in nu.
• ieșire Fix pentru listele enumerate cu valori de pornire în LaTeX.
• Asigurați-`` pornire after`` și `` opțiuni end-before`` la `` munca directivă literalinclude`` corect dacă nu este utilizat împreună.
• Fix generație link în constructor LaTeX.

Ce este nou în versiunea 0.6.4:

• Îmbunătățirea manipularea șirurilor non-Unicode în configurația.
• OSErrors captură apare atunci când apel Graphviz cu argumente că nu înțelege.
• Restaurare compatibilitatea cu Pygments & gt;. = 1,2
• Fix a scăpa de obiective hyperref producției LaTeX.
• Fix link-uri generate de ``: doc:. `` Rolul de ieșire LaTeX
• Collect todo noduri după întregul document a fost citit; acest lucru permite plasarea trimiterile de substituție în todo obiecte.
• Nu ignora o `` valoare explicită config today`` în construcție LaTeX.
• `` Textul alt`` diagramelor de moștenire este acum mult mai curat.
• Ignorați imagini în titluri de secțiune la generarea legende link.
• Mesaje Suport excepție în `` blocurile testoutput`` de `` extinderea doctest``.
• blocuri de linie sunt decorate în mod corespunzător în producția HTML.
• Made din nou `` munca de valoare config locale_dirs``.
• `` valori html_context`` dat pe linia de comandă, prin intermediul `` -A`` nu ar trebui să suprascrie alte valori indicate în conf.py.
• Fix un bug prevenirea reconstruiește elementare pentru `` constructor dirhtml``.
• Fix mangling de citate in unele blocuri literale.
• calea Fix la indexul de căutare pentru `` constructor dirhtml``.
• Fix o problemă de compatibilitate Jython: face dependența de `` modulul parser`` opțional
.
• În AutoDoc, prinde toate erorile care apar pe modul import, nu doar `` ImportError``.
• Fix manipularea non-date, dar nu metoda descriptorii din AutoDoc.
• Când copiați fișiere ori, ignora OSErrors ridicate de `` os.utime () ``.

Cerințe :

• Pygments 1.2 sau mai mare
• Jinja 2.3 sau mai mare
• Docutils 0/7 sau mai mare