Sphinx

När skapas för första gången, är det huvudsakliga syftet var att fungera som en dokumentation generator för Python : s egen kod.
Sedan dess har projektet nått kultstatus i utvecklingen världen, är en av de mest refererade influenser i de flesta automatiska dokumentation generatorer runt, oavsett språk.
Idag, förutom bara Python, Sphinx kan också användas med C och C ++ kod samt.

Vad är nytt i den här versionen:

• Lägg till bekvämlighet direktiv och roller till C ++ domain: direktiv `` CPP: var`` som alias för `` CPP: member``, roll ``: CPP: var`` som alias för ``: cpp: medlem `` och roll `any` för korshänvisning till någon C ++ declaraction.
• : confval: `source_suffix` config värde kan nu vara en lista med flera suffix
.
• Lägg möjligheten att ange käll tolkare av käll suffix med: confval. `Source_parsers` config värde
• En ny byggmästare, AppleHelpBuilder har lagts som bygger Apple Hjälp böcker.

Vad är nytt i version 1.2.3 / 1.3b3:

• Inkom `` sphinx.version_info`` tuple för programmatisk kontroll av Sphinx versionen.

Vad är nytt i version 1.1.3:

• Fixat krasch med vissa inställningar: confval. `Modindex_common_prefix`
• Fast hantering av `` -D`` och `` -A`` alternativ på Python 3.
• Erkänd och varna om cirkulära toctrees, i stället för att köra in rekursion fel.
• Restore kompatibilitet med docutils stammen.
• Fixat Htmlhelp indexpost länkar igen.
• Fast inheritance_diagram höja attribut fel på builtins.
• Fasta kraschar när sätter kommentarer eller ensamstående termer i en ordlista.
• Fast HTML-hjälp språk / kodning kartläggning för alla Sphinx språk som stöds.

Vad är nytt i version 1.1:

• Funktioner läggas:
• Lade Python 3.x stöd.
• Nya byggare och delsystem.
• Oförenliga ändringar:
• : första: dir: `py:-moduler direktiv inte utgångs dess` `platform`` optionsvärdet längre. (Det var det enda som direktivet gjorde utgång, och därför ganska inkonsekvent.)
• Removed stöd för gamla beroende versioner.
• Nya språk:
• Inkom svenska språk.
• Inkom iranska språk.
• Inkom lettiska språk.
• Inkom nepalesiska locale.
• Inkom koreanska språk.
• Inkom estniska språk.

Vad är nytt i version 1.0.8:

• Fix tracebacks för AttributeErrors i autosummary generation.
• Fäst `` abbr`` roll när förkortningen har radbrytningar i det.
• Fäst länkar till sökresultat med anpassade objekttyper.
• Fix radnummer redovisas i varningar om odefinierade referenser.
• Fix C ++ array definitioner och mall argument som inte är av typen namn.
• Tillåt fotnoter i sektionsrubriker i LaTeX utgång.
• Tillåt nyckelord för att länkas via intersphinx.
• Tillåt Unicode-tecken i produktionen lista symboliska namn.
• Lägg dummy besökare för GraphViz noder för text och människan.
• Fix bildfil dubbel bugg.
• Fix tolkning av flera signaturer i C ++ domän.
• Ignorera Emacs låsfiler när man letar efter källfiler.
• Tillåt .pyw förlängning importeras moduler i Autodoc.
• Använd `` $ (märke) `` i snabbstart-genererade Makefiler.
• Se sidofältet sökrutan bredd konsekvent i webbläsare.
• Fix avståndet mellan centrerade siffror i HTML-utdata.
• Säker koda SphinxError meddelanden när du skriver ut dem för att sys.stderr.
• Fix LaTeX utdatafel med ett dokument utan sektioner men en länk mål.
• Korrekt behandla inbyggda metodbeskrivningar som metoder i Autodoc.
• Stoppa monkeypatching Python textwrap modulen.
• Viewcode fungerar nu korrekt med källfiler som har icke-ASCII-kodning.
• Respektera `` noindex`` flaggan alternativet i py. Direktiv modul
• Fix IndexErrors när inklusive obefintlig rader med: rst: dir:. `Literalinclude`
• Respekt anpassade funktion / metod parameter separator strängar.
• Fix JS oförenlighet med jQuery & gt;. = 1,5
• Fix dubbel kodning gjort när du skriver Htmlhelp .hhk filer.
• Använd inte smartypants i analyserade-bokstav block.
• C ++ domän stöder nu array definitioner.

Vad är nytt i version 1.0.6:

• Fix uppföljnings i Python domän för tomma korsreferens mål.
• Fix bokstav blockera bildskärmsproblem på Chrome webbläsare.
• Support sortering ett begränsat antal accenttecken i generalindex och ordlistan.
• Försök avkodning `` -D`` och `` -A`` kommandoradsargument med lokalen föredrar kodning.
• Observera: confval. `Locale_dirs` när vi letar efter JS översättningar fil
• Lägg speciell kod för bättre stöd av japanska dokument i LaTeX byggare.
• Regression av # 77: Om det bara finns en parameter ges med ``: param. `` Uppmärkning, kulan listan nu undertrycks igen
• Fix saknas styckebrytningar i LaTeX utgång i vissa situationer.
• Emit den `` Autodoc-process docstring`` händelse även för objekt utan en docstring så att den kan lägga till innehåll.
• I LaTeX byggare, inte bara bokstav block kräver olika bordshantering, men också en hel del andra listliknande blockelement.
• Fix tracebacks i viewcode förlängning för Python objekt som inte har en giltig signatur.
• Fix konstiga reportings av radnummer för varningar som genereras från Autodoc-inkluderat docstrings, på grund av olika beteenden beroende på docutils version.
• Flera fixar till C ++ domänen.

Vad är nytt i version 1.0.5:

• Lägg till CSS-format som krävs av docutils 0,7 för inriktade bilder och figurer.
• I Makefile som genereras av LaTeX utgång, inte ta bort pdf-filer på ren; de kan krävas bilder.
• Fix LaTeX utdata som genereras för linjeblock.
• Tillåt `` .pyw`` som en källa filändelse.

Vad är nytt i version 1.0.4:

• Öppna intersphinx inventeringar i binärt läge i Windows, sedan version 2 innehåller zlib-komprimerade data.
• Tillåt att ge icke-lokala URI för JavaScript-filer, t.ex. i JSMath förlängning.
• Fix uppföljnings när `` intersphinx_mapping`` är tom.

Vad är nytt i version 1.0.3:

• Fix intern kontra extern länk skillnad för länkar som kommer från en docutils table-of-innehåll.
• Fäst `` maxdepth`` alternativ för `` toctree () `` mall inlösbara när den används med `` kollaps = True``.
• Fix krasch pars Python argumentlistor som innehåller parentes i stränglitteraler.
• Fix regression när man bygger LaTeX dokument med siffror som inte har bildtexter.
• Fix arv diagram för klasser som inte är picklable.
• Presentera separat bakgrundsfärg för sidofältet kollaps knappen, vilket gör det lättare att se.
• Fix små layout buggar i flera inbyggda teman.

Vad är nytt i version 1.0.2:

• Fix korsreferenser till objekt av typer som lagts till av: funk. `~ .Sphinx.add_object_type` API-funktion
• Fix hantering av doc fälttyper för olika direktiv typer.
• Tillåt bryta långa signaturer, fortsätter med glapp rymt radbrytningar.
• Fix oönskad styling av C-domänen referenser (på grund av ett namn konflikt med Pygments stilar).
• Tillåt hänvisningar till PEP och RFC med explicita ankare.
• Fix LaTeX hänvisningar till siffror.
• När du gör en icke-exakt sökning, match endast viss typ av objekt.
• Använd inte exakt sökning för Python referens mål med `` .name`` för modulerna.
• Fix krasch när duplicera en parameter i ett informationsfält listan.
• Fix standardinställning roll som tillhandahålls av den `` oldcmarkup`` förlängning.
• Fix krasch när json-py installeras, vilket ger en `` json`` modul men är oförenligt med simplejson.
• Fix hantering av mål namngivning i intersphinx.
• Fix borttagning av ``! `` För alla korsreferens roller.

Vad är nytt i version 1.0.1:

• Fix genererade målnamn för vila domänobjekt; de är inte i samma namnområde.
• Lägg till Bengali språket.
• Fix en bugg i pars JavaScript objektnamn.
• Fix byggnad med SingleHTMLBuilder när ingen toctree.
• Fix visningsnamn för objekt som är kopplade till genom intersphinx med explicita mål.
• Fix byggnad med JSON byggare.
• Fix hyperrefs i beskrivningar objekt för LaTeX.

Vad är nytt i version 1.0:

• Allmänt:
• Lade till en "nitpicky" -läge som avger varningar för alla saknade referenser. Den aktiveras av: alternativ: `-n` kommandoradsväxel eller: confval.` Nitpicky` config värde
• Inkom `` latexpdf`` mål i snabbstart Makefile.
• Markup:
• : första: roll: `menuselection` och: rst: roll:.` Guilabel` roller nu stödja et-acceleratorer
• Ny mer kompakt doc fält syntax erkänns nu: ``: param typnamn. Description``
• Inkom `` tab-width`` alternativ till: rst: dir. `Literalinclude` direktiv
• Inkom `` titlesonly`` alternativet: rst: dir. `Toctree` direktiv
• Lade till `` prepend`` och `` append`` alternativ till: första: dir. `Literalinclude` direktiv
• Alla docinfo metadata nu lägga till dokumentet metadata, inte bara författaren.
• : rst: roll: `ref` roll kan nu också referera tabeller med bildtext
.
• : rst: dir. `Include` direktiv stöder nu absoluta sökvägar, som tolkas som relativt källkatalogen
• I Python-domänen, referenser som ``: funk:. `.name``` Nu leta efter matchande namn med någon prefix, om ingen direkt matchning hittas
• Konfiguration:
• Lade: confval. `Rst_prolog` config värde
• Lade: confval. `Html_secnumber_suffix` config värde för att styra avsnitt numrering format
• Lade: confval. `Html_compact_lists` config värde för att styra docutils" kompakta listor har
• : confval: `html_sidebars` config värde kan nu innehålla mönster som nycklar och värden kan vara listor som uttryckligen välja vilken sidebar mallar bör göras. Det betyder att builtin sidofältets innehåll kan inkluderas endast selektivt.
• : confval:. 'Html_static_path` kan nu innehålla poster enstaka fil
• Den nya universella config värde: confval: `exclude_patterns` gör den gamla: confval:` unused_docs`,: confval: `exclude_trees` och: confval.` Exclude_dirnames` föråldrade
• Lade: confval. `Html_output_encoding` config värde
• Lagt till: confval: `latex_docclass` config värde och gjorde" twoside "document alternativet overridable med" oneside "
.
• Lagt till: confval. `Trim_doctest_flags` config värde, vilket är sant som standard
• Lade: confval. `Html_show_copyright` config värde
• Lade: confval: `latex_show_pagerefs` och: confval.` Latex_show_urls` config värden
• beteende: confval: `html_file_suffix` ändrats något: den tomma strängen betyder nu" ingen ändelsen "i stället för" default suffixet ", användning` `None`` för" default suffixet "
.
• Nya byggare:
• Lade till en byggare för Epub-formatet.
• Lade till en byggare för manualsidor.
• Lade till en enda fil HTML builder.
• HTML-utdata:
• Inline roller får nu en CSS-klass med deras namn, vilket gör stilar för att anpassa deras utseende. Domänspecifika roller får två klasser, `` domain`` och `` domän rolename``.
• Referenser få nu klassen `` internal`` om de är interna för hela projektet, i motsats till den inre till den aktuella sidan.
• Externa referenser kan stylas på olika sätt med den nya `` externalrefs`` tema alternativet för standardtemat.
• I standardtema, sidofältet kan experimentellt nu göras hopfällbar med det nya `` collapsiblesidebar`` tema alternativ.
• Toctrees nu insvept i en `` div`` tagg med klassen `` toctree-wrapper`` i HTML-utdata.
• : data:. `Toctree` inlösbara mallar har nu en` `maxdepth`` sökord argument för att styra djupet av den genererade träd
• : data:. `Toctree` inlösbara mallar nu accepterar en` `titles_only`` sökordet argument
• Inkom `` htmltitle`` block i layouten mallen.
• I JavaScript sökningen möjligt att leta efter för objektnamn inklusive modulnamnet, som `` sys.argv``.
• Inkom nytt tema `` haiku``, inspirerad av Haiku OS bruksanvisning.
• Inkom nytt tema `` nature``.
• Inkom nytt tema `` agogo``, skapad av Andi Albrecht.
• Inkom nytt tema `` scrolls``, skapad av Armin Ronacher.
• Lade till en `` visitedlinkcolor`` tema alternativ till standardtemat.
• Förbättrad respons på söksidan genom att ladda thesearch index asynkront.
• Extension API:
• Added: event. `Html-Collect-pages`
• Lade: confval: `needs_sphinx` config värde och: meth.` ~ Sphinx.application.Sphinx.require_sphinx` ansökan API metod
• Lade: meth. `~ Sphinx.application.Sphinx.add_stylesheet` ansökan API metod
• Tillägg:
• Lagt till: mod: `~ sphinx.ext.viewcode` förlängning
.
• Lagt till: mod: `~ sphinx.ext.extlinks` förlängning
.
• Utökat stöd för käll beställning av medlemmar i Autodoc, med `` autodoc_member_order = 'bysource'``.
• Lade: confval. `Autodoc_default_flags` config värde, som kan användas för att välja standardflaggor för alla direktiv Autodoc
• Lade till en väg för intersphinx att hänvisa till namngivna etiketter i andra projekt, och att ange det projekt som du vill länka till.
• Autodoc kan nu dokumentera exempel attribut tilldelas i `` __init__`` metoder.
• Många förbättringar och fixar till: mod. `~ Sphinx.ext.autosummary` förlängning, tack vare Pauli Virtanen
• : mod: `~ sphinx.ext.graphviz` förlängning kan nu utgångs SVG i stället för PNG-bilder, som kontrolleras av confval.` Graphviz_output_format` config värde
• Inkom `` alt`` alternativet: rst: dir. `Direktiv graphviz` förlängning
• Inkom `` exclude`` argument till: funk. `.autodoc.between`
• Översättningar:
• Inkom kroatiska översättning, tack vare Bojan Mihelac.
• Inkom turkiska översättning, tack vare Firat Ozgul.
• Lade katalanska översättning, tack vare Pau Fernandez.
• Inkom förenklad kinesiska översättningen.
• Inkom danska översättning, tack vare Hjorth Larsen.
• Added litauiska översättning, tack vare Dalius Dobravolskas.

Vad är nytt i version 1.0b1:

• Stöd för domäner har lagts till. En domän är en samling direktiv och roller som alla beskriver föremål samhörighet, t.ex. element i ett programmeringsspråk. Några inbyggd domäner finns: - Python - C - C ++ - JavaScript - ReStructuredText
• Den gamla uppmärkning för att definiera och länka till C-direktiven fungerar inte längre utan att aktivera `` oldcmarkup`` förlängning.
• Removed stöd för gamla beroende versioner.
• Borttagna nedgraderade element.

Vad är nytt i version 0.6.5:

• I Autodoc, fixa utelämnandet av vissa modulelementen explicit dokumenterade med hjälp av dokumentation kommentarer.
• Fix beskärning av sidofältet rullningslisten med `` stickysidebar`` alternativet standardtemat.
• alltid generera UNIX radbrytningar i quickMakeFile.
• Fix kör med `` -C`` under Windows.
• I Autodoc, tillåta att anpassa undertecknandet av ett objekt där inbyggd mekanism misslyckas.
• Fix utgång för uppräknade listor med startvärden i LaTeX.
• Gör `` start after`` och `` slut before`` alternativ till `` literalinclude`` direktivet fungerar korrekt om den inte används tillsammans.
• Fix länk generation i LaTeX byggare.

Vad är nytt i version 0.6.4:

• Förbättrad hantering av icke-Unicode-strängar i konfigurationen.
• Fångst OSErrors inträffar när du ringer graphviz med argument som inte förstår.
• Restore kompatibilitet med Pygments & gt;. = 1,2
• Fix fly av hyperref mål i LaTeX utgång.
• Fix länkar som genereras av ``: doc. `` Roll LaTeX utgång
• Samla todo noder efter hela dokumentet har lästs; detta gör det möjligt att placera ersättnings referenser todo poster.
• Ignorera inte en explicit `` today`` config värde i en LaTeX bygga.
• `` alt`` texten i arvs diagram är nu mycket renare.
• Ignorera bilder i Rubrikerna när du skapar länktexter.
• stöd undantagsvis meddelanden i `` testoutput`` block av `` doctest`` förlängning.
• Fodra block utformade på rätt sätt i HTML-utdata.
• Gjorde `` locale_dirs`` config värde arbeta igen.
• `` html_context`` värdena finns angivna på kommandoraden via `` -A`` bör inte åsidosätta andra värden som anges i conf.py.
• Fix en bugg förhindra inkrementella ombyggnader för `` dirhtml`` byggare.
• Fäst mangling av citat i vissa bokstav block.
• Fix sökvägen till sökindex för `` dirhtml`` byggare.
• Fix en Jython kompatibilitetsproblem: gör beroendet av `` parser`` modul som tillval
.
• I Autodoc, fånga alla fel som uppstår på modulen import, inte bara `` ImportError``.
• Fix hanteringen av icke-data, men icke-metoden beskrivningar i Autodoc.
• När du kopierar fil gånger, ignorera OSErrors tagits upp av `` os.utime () ``.

Krav :

• Pygments 1.2 eller högre
• Jinja 2.3 eller högre
• Docutils 0/7 eller högre