Sphinx

sukurta pirmą kartą, tai pagrindinis tikslas buvo tarnauti kaip dokumentų generatoriaus Python s savo kodą.
Nuo tada, projektas pasiekė kulto statusą plėtros pasaulyje, yra vienas iš labiausiai nuorodose poveikiui dauguma automatinių dokumentacijos generatorių aplink, nepriklausomai nuo kalbos.
Šiandien, be to tik Python, Sfinksas taip pat gali būti naudojamas kartu su C ir C ++ kodo taip pat.

Kas naujo , šioje laidoje:

• Pridėti patogumui direktyvas ir vaidmenis, C ++ domeno: direktyva `` cpp: var`` kaip alias `` CVP: member``, vaidmenį ``: CPP: var`` kaip alias ``: cpp: Narys `` ir vaidmuo "any` kryžminiam nuoroda į bet kurią C ++ declaraction.
• : confval: "source_suffix` konfigūracijos vertė dabar gali būti kelių priesagų sąrašas,
.
• Pridėti gebėjimą nurodyti šaltinį sintaksės analizatoriaus iki šaltinio priesaga su: confval:. `Source_parsers` konfigūracijos vertė;


• Naujas statybininkas, AppleHelpBuilder, buvo pridėta, kad stato Apple Pagalba knygos.

Kas naujo versiją 1.2.3 / 1.3b3:

• Pridėta `` sphinx.version_info`` kortežą ir programiškai tikrinimas Sfinksas versiją.

Kas naujo versijos 1.1.3:

• Fiksuotas avarijos su kai kuriais parametrais: confval:. `Modindex_common_prefix`
• Fiksuotas tvarkymas `` -D`` ir `` -A`` parinktis Python 3.
• Atpažinai ir perspėti apie sukamaisiais toctrees, vietoj važiavimo į Rekursija klaidų.
• Atkurti suderinamumą su docutils kamieno.
• Fiksuoti HTMLHelp puslapis įrašas nuorodos dar kartą.
• Fiksuotas inheritance_diagram didinimo atributų klaidų builtins.
• Fiksuoti avarijos, kai išleisti komentarų ar vienišus terminus į žodynėlį.
• Fiksuotas HTML Pagalba kalba / kodavimas kartografavimo visiems Sfinksas kalbos ".

Kas naujo 1.1 versijoje:

• Įranga pridūrė: "
• patalpintas Python 3.x parama.
• Nauji statybininkai ir posistemis.
• Nesuderinamos pokyčiai: "
• : RST: rež: "PY: module` direktyva neturi išėjimo jo` `platform`` pasirinkimo sandorio vertė daugiau. (Tai buvo vienintelis dalykas, kad direktyva nebuvo išvestį, todėl gana prieštaringi.);
• Pašalinta parama senų priklausomybių versijomis.
• Nauja aplinka: "
• Pridėta švedų lokalė.
• Pridėta Irano lokalė.
• Pridėta Latvijos lokalė.
• Pridėta Nepalo lokalė.
• Pridėta Korėjos lokalę.
• Pridėta Estijos lokalė.

Kas naujo versijos 1.0.8:

• Fix tracebacks už AttributeErrors į autosummary kartos.
• Fix `` abbr`` vaidmenį, kai santrumpa yra naujas eilutes į jį.
• Nustatyti nuorodas į paieškos rezultatus su muitinės tipų objektų.
• Nustatyti linijos numeriai pranešta apie įspėjimus apie neapibrėžtais nuorodomis.
• Fix C ++ masyvo apibrėžimai ir šablono argumentų, kurių tipas nebuvo pavadinimus.
• Leisti išnašas skyriuje antraštes LaTeX produkcija.
• Leisti raktinius būti susietas per intersphinx.
• Leisti Unicode simbolių gamyba sąrašas simbolinis pavadinimus.
• Pridėti manekeno lankytojus graphviz mazgų teksto ir žmogus.
• Nustatyti vaizdo failo kopijavimas klaidą.
• Nustatyti apdorojant kelis parašų C ++ srityje.
• Ignoruoti Emacs užraktas failus, kai ieškote šaltinio failus.
• Leisti .pyw pratęsimo importuojamas modulių autodoc.
• Naudoti `` $ (įsitikinkite) `` į quickstart sukurto Makefiles.
• Padaryti parankinės paieškos laukelio plotis atitinka naršyklėse.
• Nustatyti tarpai tarp kurių centrai figūrų HTML produkcija.
• saugiai užkoduoti SphinxError pranešimus spausdinant juos sys.stderr.
• Nustatyti LaTeX produkcijos klaidą su dokumentu be jokių skyriuose, bet nuoroda tikslą.
• Teisingai gydyti įmontuotą metodas aprašai, kaip metodų autodoc.
• Sustabdyti monkeypatching Python textwrap modulį.
• Viewcode dabar veikia teisingai su šaltinio failus, kurie turi ne ASCII koduotę.
• Pagarba `` noindex`` vėliavos variantą PY:. Modulio direktyvų;
• Fix IndexErrors kai tarp neegzistuojančius linijas: RST: rež. `Literalinclude`
• Pagarba užsakymą funkcija / metodas parametras selektyviniai eilutes.
• Nustatyti JS nesuderinamumo su JQuery & gt;. = 1,5;
• Nustatyti dvigubą kodavimą padaryta rašant HTMLHelp .hhk failus.
• Netepkite SmartyPants į išnagrinėtą-pažodinio blokus.
• C ++ domenas dabar palaiko masyvo apibrėžimus.

Kas naujo versijos 1.0.6:

• Nustatyti Pėdsakus Python domeną tuščių kryžminių nuorodų tikslus.
• Nustatyti pažodinis blokas ekrano klausimus Chrome naršyklių.
• Pagalba rūšiavimo ribotą asortimentą diakritiniais ženkleliais bendrojo indekso ir žodynėlį.
• Pabandykite dekodavimo `` -D`` ir `` -A`` komandų eilutės argumentus lokalės pageidaujamą kodavimas.
• Laikykitės: confval:. `Locale_dirs` kai ieškote JS vertimai failą
• Pridėti specialų kodą geresnio paramos Japonijos dokumentų latekso statybininkas.
• regresija # 77: Jei yra tik vienas parametras skiriamas kartu su ``: Parametras:. `` Antkainis, kulka sąrašas dabar yra slopinamas vėl "
• Nustatyti trūksta pertraukas punkte LaTeX produkcijos tam tikrose situacijose.
• skleidžia `` autodoc-procesas-docstring`` renginį net objektams be docstring, kad ji galėtų papildykite ją.
• LaTeX statybininkas ne tik pažodinis blokai reikalauja skirtingų stalo tvarkymą, bet ir nemažai kitų sąrašas panašūs blokiniai elementai.
• Fix tracebacks į viewcode pratęsimo Python objektų, kurie neturi galiojančio parašą.
• Nustatyti keistų reportažai linija skaičių įspėjimų, gautų iš autodoc-įtrauktas docstrings dėl skirtingų elgesio, priklausomai nuo docutils versiją.
• Keletas pataisymai C ++ srityje.

Kas naujo versijos 1.0.5:

• Pridėti CSS stilių, kurių reikalaujama pagal docutils 0,7 pagal suderintus vaizdų ir figūrų.
• Makefile generuoja LaTeX produkcijos, nereikia trinti PDF failus ant švarios; jie gali būti reikalaujama vaizdų.
• Nustatyti LaTeX produkcijos sugeneruotas linijos blokų.
• Leisti `` .pyw`` kaip šaltinį failo plėtinys.

Kas naujo versijos 1.0.4:

• Open intersphinx atsargos dvejetainiu Windows, nes 2 versija sudėtyje yra Zlib suspausto duomenis.
• Leisti duoti ne vietos URI JavaScript failus, pvz į JSMath pratęsimo.
• Nustatyti Pėdsakus kai `` intersphinx_mapping`` tuščias.

Kas naujo versijos 1.0.3:

• Nustatyti vidaus vs external link pagyrimu už nuorodas, gaunamų iš docutils stalo-of-turinio.
• Fix `` maxdepth`` parinktį `` toctree () `` šablonas pareikalavimo, kai naudojamas su `` sutraukti = True``.
• Nustatyti avarijos apdorojant Python argumentų sąrašus, kuriuose skliausteliuose eilutėse.
• Nustatyti regresiją statant LaTeX dokumentus su duomenimis, kurie neturi antraščių.
• Fix paveldėjimo diagramos klasėms, kurių nėra picklable.
• Įvesti atskirą fono spalvą už parankinės žlugimo mygtuką, kad būtų lengviau pamatyti.
• Nustatyti mažų išdėstymo klaidas keliose built-in temomis.

Kas naujo versijos 1.0.2:

• Nustatyti kryžmines nuorodas į objektų tipų pridėta: func:. `~ .Sphinx.add_object_type` API funkcija,
• Nustatyti tvarkymas dok lauko tipų skirtingiems direktyvos tipų.
• Leisti kad ilgus parašus, tęsiant Sandarus pabėgo naujomis eilutėmis.
• Nustatyti nepageidaujamą stilių C domenų nuorodomis (dėl vardų susidūrimas su pygments stilių).
• Leisti nuorodas į peps ir RFC su aiškiais inkarai.
• Nustatyti LaTeX nuorodos į duomenis.
• Kai darai ne tiksliai paiešką, rungtynės tik tam tikro tipo objektą.
• Taikyti ne tiksliai paiešką Python atskaitos tikslais su `` .name`` moduliai taip pat.
• Nustatyti avarijos, kai dauginimo ir įvairiais pavidalais informacijos lauko sąrašo parametrą.
• Nustatyti nustatyti numatytąjį vaidmenį viename nurodyta `` oldcmarkup`` pratęsimo.
• Nustatyti avarijos, kai JSON-PY yra įdiegtas, kuri suteikia `` json`` modulį, bet yra nesuderinama su simplejson.
• Nustatyti tvarkymo tikslas įvardijimo į intersphinx.
• Nustatyti pašalinimas ``! `` Visiems kryžminių nuorodų vaidmenis.

Kas naujo versijos 1.0.1:

• Nustatyti generuoja tikslines vardus poilsiui domenų objektų; jie nėra toje pačioje vardų.
• Pridėti Bengalų kalba.
• Nustatyti klaidą ir apdorojant JavaScript objektų pavadinimus.
• Nustatyti pastatas su SingleHTMLBuilder kai nėra toctree.
• Nustatyti ekrano pavadinimai objektų, susijusių su pagal intersphinx su aiškiai apibrėžtais tikslais.
• Nustatyti pastato su JSON statybininkas.
• Fix hyperrefs objekte aprašymai latekso.

Kas naujo 1.0 versijoje:

• Bendra: "
• Pridėta "nitpicky" režimą, kuris skleidžia įspėjimus visiems dingusių nuorodomis. Jis aktyvuoja: option: `-n` komandų eilutės jungiklis arba: confval:.` Nitpicky` config vertės;
• Pridėta `` latexpdf`` taikiniu quickstart Makefile.
• Žymėjimo: "
• : RST: vaidmuo: "menuselection` ir: RST: vaidmuo." Guilabel` vaidmenis dabar palaiko Ampersand greitintuvai;
• Nauja kompaktiškas dok laukas sintaksė dabar pripažinta: ``: Param tipo pavadinimas:. Description``
• Pridėta `` tab width`` galimybė: RST: rež. `Literalinclude` direktyvos
• Pridėta `` titlesonly`` galimybė: RST: rež. `Toctree` direktyvos
• Pridėta `` prepend`` ir `` append`` galimybes į: RST: rež. `Literalinclude` direktyvos
• Visi docinfo metaduomenys dabar įdėti į dokumentų metaduomenis, ne tik autorius.
• : RST: vaidmuo: "ref` vaidmuo dabar gali taip pat nuoroda lenteles eilutėje;
.
• : RST: rež. `Include` direktyva dabar palaiko absoliučius kelius, kurie yra traktuojami kaip, palyginti su šaltinio katalogą,
• Python domeno, nuorodos, kaip ``: func: `. .name``` Dabar atrodo atitikimo pavadinimus su bet priešdėlis, jei nėra tiesioginio randamas atitikmuo,
• Sąranka: "
• Parašytas: confval:. `Rst_prolog` konfigūracijos vertė;
• Parašytas: confval:. `Html_secnumber_suffix` konfigūracijos vertė kontroliuoti skyrių numeravimo formatą;
• Parašytas: confval:. `Html_compact_lists` konfigūracijos vertė kontroliuoti docutils" kompaktiškas sąrašai funkcija;
• : confval: "html_sidebars` konfigūracijos vertė dabar gali būti modelius, kaip raktus ir vertybės gali būti sąrašai aiškiai pasirinkti, kuris parankinės šablonai turėtų būti priimtas. Tai reiškia, kad builtin parankinės turinys gali būti įtraukiami tik selektyviai.
• confval:. `Dabar html_static_path` gali būti vienas failas įrašus,
• Naujas universalus konfigūracijos vertė: confval: "exclude_patterns` daro Amžius: confval:` unused_docs`,: confval: `exclude_trees` ir: confval:.` Exclude_dirnames` pasenęs,
• Parašytas: confval:. `Html_output_encoding` konfigūracijos vertė;
• Pridėta: confval: `latex_docclass` config vertę ir padarė" twoside "documentclass variantą overridable žodžiais" vienpusiam "
.
• Pridėta: confval:. `Trim_doctest_flags` config vertę, kuri yra teisinga pagal nutylėjimą;
• Parašytas: confval:. `Html_show_copyright` konfigūracijos vertė;
• Parašytas: confval: "latex_show_pagerefs` ir: confval:.` Latex_show_urls` config vertės;
• elgesys: confval: "html_file_suffix` šiek tiek pasikeitė: tuščia eilutė dabar reiškia" ne priesaga "vietoj" default priesaga ", naudoti` `None`` už" default priesaga "
.
• Nauji statybininkai: "
• Pridėta statybininkas už Epub formatu.
• Pridėta statybininkas mechaninėms puslapiuose.
• Pridėta vieno failo HTML statybininkas.
• HTML galia:
• Inline vaidmenis dabar gauti CSS klasę su savo vardu, todėl stilių pritaikyti savo išvaizdą. Domenų konkrečių vaidmenų gauti dvi klases `` domain`` ir `` domeno rolename``.
• Nuorodos dabar gauti klasė `` internal`` jei jie yra vidinis visam projektui, o ne vidaus į esamą puslapį.
• Išoriniai nuorodos gali būti stilingi kitaip su nauja `` externalrefs`` tema galimybe numatytąją tema.
• numatytąją temą, parankinės gali eksperimentiškai dabar būti išardomi, naudojant naują `` collapsiblesidebar`` tema parinktį.
• Toctrees dabar suvynioti į `` div`` tegus su klasės `` toctree-wrapper`` HTML produkcija.
• Duomenys:. `Toctree` pareikalavimo šablonus dabar turi` `maxdepth`` raktažodžių argumentą, reguliuojančio sugeneruoto medžio gylį;
• Duomenys:. `Toctree` pareikalavimo šablonus dabar priima` `titles_only`` raktažodžių argumentą,
• Pridėta `` htmltitle`` blokas išdėstymo šabloną.
• JavaScript paiešką, leidžia ieškoti objektų pavadinimų, įskaitant modulio pavadinimas, kaip `` sys.argv``.
• Pridėta naują temą `` haiku``, įkvėptą "Haiku OS vartotojo vadove.
• Pridėta nauja tema `` nature``.
• Pridėta naują temą `` agogo``, sukurtą Andi Albrecht.
• Pridėta naują temą `` scrolls``, sukurtą Armin Ronacher.
• Pridėta `` visitedlinkcolor`` tema parinktį numatytąją tema.
• Geresnis reagavimo į paieškos puslapį pakrovimo thesearch indeksą asinchroniškai.
• pratęsimas API: "
• Pridėta: Renginys:. `HTML-rinkti-pages`
• Parašytas: confval: "needs_sphinx` konfigūracijos vertė ir: meto:.` ~ Sphinx.application.Sphinx.require_sphinx` taikymas API metodas;
• Parašytas: meto:. `~ Sphinx.application.Sphinx.add_stylesheet` taikymas API metodas;
• plėtinių: "
• Pridėta: mod: `~ sphinx.ext.viewcode` pratęsimo;
.
• Pridėta: mod: `~ sphinx.ext.extlinks` pratęsimo;
.
• Pridėtas šaltinis užsakymui narių autodoc, su `` autodoc_member_order = 'bysource'``.
• Parašytas: confval:. `Autodoc_default_flags` konfigūracijos vertė, kuri gali būti naudojama pasirinkti numatytuosius vėliavas visiems autodoc direktyvų;
• Pridėta kelią intersphinx kreiptis į pavadintas etikečių kitų projektų, ir nurodyti projekto, kurį norite susieti.
• autodoc dabar gali dokumentuoti instancija atributus priskirti į `` __init__`` metodus.
• Daug patobulinimų ir pataisymai: mod:. `~ Sphinx.ext.autosummary` pratęsimo dėka Pauli Virtanen
• : mod: `~ sphinx.ext.graphviz` pratęsimas gali dabar išvesties SVG vietoj PNG paveikslėlių, kontroliuoja confval:.` Graphviz_output_format` konfigūracijos vertė;
• Pridėta `` alt`` galimybė: RST: rež. `Graphviz` pratęsimo direktyvų;
• Pridėta `` exclude`` argumentas: func:. `.autodoc.between`
• Vertimai: "
• Pridėta Kroatų Vertimas, dėka Bojan Mihelac.
• Pridėta Turkų Vertimas, dėka Firat Özgül.
• patalpintas Katalonų Vertimas, dėka Pau Fernandez.
• Pridėta supaprastinta kinų vertimas.
• Pridėta Danų Vertimas, dėka Hjorth Larsen.
• Pridėta Lietuvių Vertimas, dėka Dalius Dobravolskas.

Kas naujo versija 1.0b1:

• Parama srityse buvo pridėta. Domenas yra direktyvų ir vaidmenis, kad visi aprašyti objektų, priklausančių kartu, pvz kolekcija elementai programavimo kalba. Keletas builtin domenai, jeigu: - Python - C - C ++ - Javaskriptą - reStructuredText
• senas žymėjimas nustatyti ir nuorodas į C direktyvų bus nebeveikia nesuaktyvinę `` oldcmarkup`` pratęsimo.
• Pašalinta parama senų priklausomybių versijomis.
• Pašalinta pasenusios elementai.

Kas naujo versijos 0.6.5:

• Be autodoc, nustatyti kai kurių modulių nariai aiškiai dokumentuotas naudojant dokumentacijos komentarų neveikimas.
• Nustatyti apkarpymas iš parankinės slinkties juostos su `` stickysidebar`` galimybe iš numatytojo tema.
• Visada generuoti UNIX naujas eilutes į quickstart Makefile.
• Nustatyti veikia su `` -C`` pagal "Windows".
• Be autodoc, leidžia tinkinti objekto kurioje įmontuotas mechanizmas sugenda parašą.
• Nustatyti išėjimas išvardytų sąrašus su starto vertybių latekso.
• Padaryti `` pradžiai after`` ir `` galutinio before`` parinkčių prie `` literalinclude`` direktyvos veiktų tinkamai, jei nenaudojamas kartu.
• Nustatyti ryšį kartos į LaTeX statybininkas.

Kas naujo versijos 0.6.4:

• pagerino ne Unicode styginiams konfigūracijos valdymą.
• Sugavimo OSErrors vyksta, kai skambinama graphviz su argumentais jis nesupranta.
• Atkurti suderinamumą su pygments & gt;. = 1,2;
• Nustatyti pabėgti nuo hyperref taikinius LaTeX produkcija.
• Fix nuorodos gaminamos ``: doc. `` Vaidmenį LaTeX produkcijos
• Kolekcionavimas ToDo mazgus po visas dokumentas buvo skaityti; tai leidžia pateikti pakaitines nuorodas į Todo daiktais.
• Negalima ignoruoti aiškiai `` today`` config vertę lateksu statyti.
• `` alt`` tekstas paveldėjimo diagramas dabar daug švaresnis.
• Ignoruoti vaizdus skyrelio pavadinimą, kai generuoti nuorodą antraštes.
• Pagalba išimtis prane¹imus `` testoutput`` blokų `` doctest`` pratęsimo.
• Line blokai stiliaus tinkamai HTML produkcija.
• Made `` locale_dirs`` konfigūracijos vertės darbą dar kartą.
• `` html_context`` verčių komandinėje eilutėje per `` -A`` neturėtų nepaisyti kitų pateiktų nurodymų conf.py vertybes.
• Nustatyti klaidą užkirsti kelią papildomas atstato už `` dirhtml`` statybininkas.
• Nustatyti iš kabučių gręžimo kai pažodinis blokus.
• Nustatyti kelias į paieškos indeksą `` dirhtml`` statybininkas.
• Fix Jython suderinamumo problemą: kad priklausomybę nuo `` parser`` modulio neprivaloma;
.
• Be autodoc, sugauti visas klaidas, kurios atsiranda dėl importo modulis ne tik `` ImportError``.
• Nustatyti iš ne duomenų apdorojimo, bet ne metodas aprašai į autodoc.
• Kopijuojant failų kartus, ignoruoti OSErrors keliamus `` os.utime () ``.

Reikalavimai

• pygments 1.2 arba naujesnė versija;
• Jinja 2.3 arba naujesnė versija;
• Docutils 0/7 arba naujesnė;