Sphinx

Når skabt for første gang, er det vigtigste formål var at tjene som dokumentation generator for Python 's egen kode.
Siden da har projektet nået kultstatus i udviklingen verden, er en af ​​de mest refererede påvirkninger i de fleste automatiske dokumentation generatorer rundt, uanset sprog.
Dag, udover bare Python, Sphinx kan også bruges med C og C ++ kode samt.

Hvad er nyt i denne udgivelse:

• Tilføj convenience direktiver og roller til C ++ domænet: direktiv `` cpp: var`` som alias for `` cpp: member``, rolle ``: cpp: var`` som alias for ``: cpp: medlem ``, og rolle `any` for krydshenvisning til enhver C ++ declaraction.
• : confval: `source_suffix` config værdi kan nu være en liste over flere suffikser
.
• Tilføj evnen til at specificere kilde parsere efter kilde suffiks med: confval:. `Source_parsers` config værdi
• En ny bygherre, AppleHelpBuilder, er blevet tilføjet, som bygger Apple Hjælp Books.

Hvad er nyt i version 1.2.3 / 1.3b3:

• Tilføjet `` sphinx.version_info`` tupel for programmatisk kontrol af Sphinx version.

Hvad er nyt i version 1.1.3:

• Fast nedbrud med nogle indstillinger: confval:. `Modindex_common_prefix`
• Fast håndtering af `` -D`` og `` -A`` optioner på Python 3..
• Anerkendt og advare om cirkulære toctrees, i stedet for at løbe ind i rekursionsudtryk fejl.
• Gendan kompatibilitet med docutils stammen.
• Faste HTMLHELP indeks indrejse links igen.
• Fast inheritance_diagram hæve attribut fejl på builtins.
• Faste går ned, når sætte kommentarer eller enlige vilkår i en ordliste.
• Fast HTML-hjælp sprog / kodning kortlægning for alle Sphinx understøttede sprog.

Hvad er nyt i version 1.1:

• Features tilføjede:
• Tilføjet Python 3.x support.
• Nye bygherrer og delsystem.
• Uforenelige ændringer:
• : rst: dir: `py:-moduler direktiv ikke output sin` `platform`` optionsværdi længere. (Det var det eneste, at direktivet gjorde output, og derfor helt inkonsekvent.)
• Fjernet støtte for gamle afhængighed versioner.
• Nye lokaliteter:
• Tilføjet svensk locale.
• Tilføjet iranske locale.
• Tilføjet lettiske locale.
• Tilføjet nepalesisk locale.
• Tilføjet koreansk locale.
• Tilføjet estiske locale.

Hvad er nyt i version 1.0.8:

• Fix tracebacks for AttributeErrors i autosummary generation.
• Fastgør `` abbr`` rolle, når forkortelsen har nye linjer i det.
• Fix linkene til søgeresultater med brugerdefinerede objekt typer.
• Fix linjenumre rapporteret i advarsler om udefinerede referencer.
• Fix C ++ array-definitioner og skabelon argumenter, der ikke skrive navne.
• Tillad fodnoter i afsnittet overskrifter i LaTeX output.
• Tillad stikord til at være forbundet via intersphinx.
• Tillad Unicode-tegn i produktionen liste token navne.
• Tilføj dummy besøgende til graphviz noder til tekst og menneske.
• Fix billedfil dobbeltarbejde bug.
• Fix parsing af flere underskrifter i C ++ domæne.
• Ignorer Emacs lock-filer, når de søger kildefiler.
• Tillad .pyw udvidelse til kan indføres moduler i AutoDoc.
• Brug `` $ (MAKE) `` i quickstart-genereret Makefiler.
• Opret sidebar søgefelt bredde konsekvente i browsere.
• Fix afstand mellem centrerede figurer i HTML-output.
• Sikker indkode SphinxError meddelelser, når du udskriver dem til sys.stderr.
• Fix LaTeX output fejl med et dokument med nogen sektioner, men et link target.
• Korrekt behandle indbyggede metode deskriptorer som metoder i AutoDoc.
• Stop monkeypatching Python textwrap modulet.
• Viewcode fungerer nu korrekt med kilde filer, der har ikke-ASCII-kodning.
• Respekter `` noindex`` flag mulighed i py:. Modul direktiver
• Fix IndexErrors når herunder nonexisting linjer med: rst: dir:. `Literalinclude`
• Respekt brugerdefinerede funktion / metode parameter separator strenge.
• Fix JS uforenelighed med jQuery & gt;. = 1,5
• Fix dobbelt kodning udført, når du skriver HTMLHelp .hhk filer.
• Påfør ikke SmartyPants i parsede-bogstavelige blokke.
• C ++ domæne understøtter nu array-definitioner.

Hvad er nyt i version 1.0.6:

• Fix tilbagesporingshukommelsen i Python domæne til tomme krydshenvisning mål.
• Fix bogstavelige blok display spørgsmål, Chrome browsere.
• Support sortering et begrænset udvalg af tegn med accent i det generelle indeks og ordliste.
• Prøv at afkode `` -D`` og `` -A`` kommandolinjeargumenter med locale foretrukne kodning.
• Observer: confval:. `Locale_dirs` når de søger JS oversættelser fil
• Tilføj særlig kode for bedre støtte af japanske dokumenter i LaTeX bygherre.
• Regression af # 77: Hvis der kun er en parameter givet med ``: param:. `` Markup, liste kuglen er nu undertrykt igen
• Fix mangler afsnitsskift i LaTeX output i visse situationer.
• udsender `` AutoDoc-proces-docstring`` begivenhed selv for objekter uden en docstrengen så det kan tilføje indhold.
• I LaTeX bygherre, ikke kun bogstavelig blokke kræver anden tabel håndtering, men også et par andre liste-lignende blok elementer.
• Fix tracebacks i viewcode udvidelse til Python genstande, som ikke har en gyldig signatur.
• Fix mærkelige rapporteringer af linjenumre for advarsler genereret fra AutoDoc-inkluderet docstrings, på grund af forskellig adfærd afhængigt docutils version.
• Flere rettelser til C ++ domæne.

Hvad er nyt i version 1.0.5:

• Tilføj CSS kræves af docutils 0,7 til afstemt billeder og figurer.
• I Makefile genereres af LaTeX output, skal du ikke slette pdf filer på ren; de kunne være påkrævet billeder.
• Fix LaTeX output genereret for linje blokke.
• Tillad `` .pyw`` som en kilde filtypenavn.

Hvad er nyt i version 1.0.4:

• Åbn intersphinx opgørelser i binær tilstand på Windows, siden version 2 indeholder zlib-komprimerede data.
• Tillad at give ikke-lokale URI'er for JavaScript-filer, f.eks i JSMath forlængelse.
• Fix tilbagesporingshukommelsen når `` intersphinx_mapping`` er tom.

Hvad er nyt i version 1.0.3:

• Fix intern vs. eksternt link forskel for links, der kommer fra en docutils table-of-indhold.
• Fastgør `` maxdepth`` mulighed for `` toctree () `` skabelon konverterbare når det bruges med `` kollaps = True``.
• Fix nedbrud parsing Python argument lister med parenteser i strengkonstanter.
• Fix regression, når man bygger LaTeX docs med figurer, der ikke har billedtekster.
• Fix arv diagrammer for klasser, der ikke picklable.
• Indfør separat baggrundsfarve for indholdsoversigten sammenbrud knap, hvilket gør det nemmere at se.
• Fix små layout bugs i flere indbyggede temaer.

Hvad er nyt i version 1.0.2:

• Fix krydshenvisninger til objekter af typer tilføjet af: func:. `~ .Sphinx.add_object_type` API-funktionen
• Fix håndtering af typer doc felt for forskellige direktiv typer.
• Tillad bryde lange signaturer, fortsatte med slør-undslap nye linjer.
• Fix uønsket styling af C domæne referencer (på grund af en namespace sammenstød med Pygments stilarter).
• Tillad henvisninger til indrejseprocedurer og RFC med eksplicitte ankre.
• Fix LaTeX henvisninger til tal.
• Når du gør en ikke-eksakt søgning, match kun den givne type objekt.
• Anvend ikke-eksakt søgning efter Python referencemål med `` .name`` for moduler også.
• Fix nedbrud, når duplikere en parameter i en info felt liste.
• Fix indstille standard rollen til en fra den `` oldcmarkup`` forlængelse.
• Fix nedbrud når JSON-py er installeret, som giver en `` json`` modul, men er uforenelig med simplejson.
• Fix håndtering af target navngivning i intersphinx.
• Fix fjernelse af ``! `` For alle krydshenvisning roller.

Hvad er nyt i version 1.0.1:

• Fix genererede mål navne for REST domæne objekter; de er ikke i samme namespace.
• Tilføj Bengali.
• Fix en fejl i parsing JavaScript objekt navne.
• Fix bygning med SingleHTMLBuilder når der ikke er toctree.
• Fix display navne til objekter, der er knyttet til ved intersphinx med eksplicitte mål.
• Fastgør bygning med JSON bygherre.
• Fix hyperrefs i objekt beskrivelser for LaTeX.

Hvad er nyt i version 1.0:

• Generelt:
• Tilføjet en "nitpicky" mode, der udsender advarsler for alle manglende referencer. Den aktiveres af: indstilling: `-n` kommandolinjeparameteren eller: confval:.` Nitpicky` config værdi
• Tilføjet `` latexpdf`` mål i quickstart Makefile.
• Markup:
• : rst: rolle: `menuselection` og: rst: rolle:.` Guilabel` roller understøtter nu Ampersand acceleratorer
• Ny mere kompakt doc felt syntaks er nu anerkendt: ``: param typen navn:. Description``
• Tilføjet `` fane-width`` mulighed for at: rst: dir:. `Literalinclude` direktiv
• Tilføjet `` titlesonly`` mulighed for at: rst: dir:. `Toctree` direktiv
• Tilføjet `` prepend`` og `` append`` muligheder til: rst: dir:. `Literalinclude` direktiv
• Alt docinfo metadata er nu lagt i dokumentet metadata, ikke kun forfatteren.
• : rst: rolle: `ref` rolle kan nu også referere tabeller ved billedtekst
.
• : rst: dir:. `Include` direktiv understøtter nu absolutte stier, som fortolkes som relativ til kilden mappen
• I Python domæne, referencer som ``: func:. `.name``` Nu se efter matchende navne med nogen præfiks, hvis der ikke direkte match findes
• Konfiguration:
• Tilføjet: confval:. `Rst_prolog` config værdi
• Tilføjet: confval:. `Html_secnumber_suffix` config værdi at kontrollere sektion nummerering format
• Tilføjet: confval:. `Html_compact_lists` config værdi at kontrollere docutils 'kompakte lister har
• : confval: `html_sidebars` config værdi kan nu indeholde mønstre som nøgler, og værdierne kan være lister, udtrykkeligt vælge hvilke sidebar skabeloner bør gøres. Det betyder, at det indbyggede sidebar indholdet kan medtages kun selektivt.
• : confval:. `Nu kan html_static_path` indeholde enkelt fil poster
• Den nye universelle config værdi: confval: `exclude_patterns` gør den gamle: confval:` unused_docs`,: confval: `exclude_trees` og: confval:.` Exclude_dirnames` forældede
• Tilføjet: confval:. `Html_output_encoding` config værdi
• Tilføjet: confval: `latex_docclass` config værdi og gjorde" twoside "documentclass option overridable med" oneside "
.
• Tilføjet den: confval:. `Trim_doctest_flags` config værdi, hvilket er sandt som standard
• Tilføjet: confval:. `Html_show_copyright` config værdi
• Tilføjet: confval: `latex_show_pagerefs` og: confval:.` Latex_show_urls` config værdier
• adfærd: confval: `html_file_suffix` ændret lidt: den tomme streng betyder nu" ingen endelsen "i stedet for" default endelse ", brug` `None`` for" standard suffiks "
.
• Nye bygherrer:
• Tilføjet en bygherre for ePub-format.
• Tilføjet en bygherre for manuelle sider.
• Tilføjet en enkelt fil HTML builder.
• HTML-output:
• Inline roller nu få en CSS klasse med deres navn, så stilarter at tilpasse deres udseende. Domænespecifikke roller får to klasser, `` domain`` og `` domæne-rolename``.
• Referencer nu får klassen `` internal`` hvis de er internt i hele projektet, i modsætning til internt til den aktuelle side.
• Eksterne referencer kan styles forskelligt med den nye `` externalrefs`` tema mulighed for den standard tema.
• I standard tema, indholdsoversigten kan eksperimentelt nu gøres sammenklappelig ved hjælp af den nye `` collapsiblesidebar`` tema mulighed.
• Toctrees nu pakket ind i en `` div`` tag med klasse `` toctree-wrapper`` i HTML-output.
• : data:. `Toctree` konverterbare skabeloner har nu en` `maxdepth`` søgeord argument for at styre dybden af ​​den genererede træet
• : data:. `Toctree` konverterbare skabeloner nu accepterer en` `titles_only`` søgeord argument
• Tilføjet `` htmltitle`` blok i layout skabelon.
• I JavaScript søgning, tillade at søge efter objekt navne, herunder modulet navn, ligesom `` sys.argv``.
• Tilføjet nyt tema `` haiku``, inspireret af Haiku OS brugervejledning.
• Tilføjet nyt tema `` nature``.
• Tilføjet nyt tema `` agogo``, skabt af Andi Albrecht.
• Tilføjet nyt tema `` scrolls``, skabt af Armin Ronacher.
• Tilføjet en `` visitedlinkcolor`` tema option til standard tema.
• Forbedret reaktionsevne søgesiden ved at indlæse thesearch indeks asynkront.
• Extension API:
• Tilføjet: begivenhed:. `Html-Collect-pages`
• Tilføjet: confval: `needs_sphinx` config værdi og: meth:.` ~ Sphinx.application.Sphinx.require_sphinx` ansøgning API metode
• Tilføjet: meth:. `~ Sphinx.application.Sphinx.add_stylesheet` ansøgning API metode
• Udvidelser:
• Tilføjet: mod: `~ sphinx.ext.viewcode` udvidelse
.
• Tilføjet: mod: `~ sphinx.ext.extlinks` udvidelse
.
• Tilføjet understøttelse af kilde bestilling af medlemmer i AutoDoc, med `` autodoc_member_order = 'bysource'``.
• Tilføjet: confval:. `Autodoc_default_flags` config værdi, som kan bruges til at vælge standardindstillinger flag for alle AutoDoc direktiver
• Tilføjet en måde for intersphinx at referere til navngivne etiketter i andre projekter, og til at angive det projekt, du vil linke til.
• AutoDoc kan nu dokumentere instans attributter tildelt i `` __init__`` metoder.
• Mange forbedringer og rettelser til: mod:. `~ Sphinx.ext.autosummary` udvidelse, takket være Pauli Virtanen
• : mod: `~ sphinx.ext.graphviz` forlængelse kan nu output SVG stedet for PNG-billeder, der kontrolleres af den confval:.` Graphviz_output_format` config værdi
• Tilføjet `` alt`` mulighed for at: rst: dir:. `Graphviz` udvidelse direktiver
• Tilføjet `` exclude`` argument til: func:. `.autodoc.between`
• Oversættelser:
• Tilføjet kroatisk oversættelse, takket være Bojan Mihelac.
• Tilføjet tyrkisk oversættelse, takket være Firat Ozgul.
• Tilføjet Catalan oversættelse, takket være Pau Fernandez.
• Tilføjet forenklet kinesisk oversættelse.
• Tilføjet dansk oversættelse, takket være Hjorth Larsen.
• Tilføjet litauisk oversættelse, takket være Dalius Dobravolskas.

Hvad er nyt i version 1.0b1:

• er blevet tilføjet Støtte til domæner. Et domæne er en samling af direktiver og roller, som alle beskriver objekter høre sammen, f.eks elementer af et programmeringssprog. Enkelte builtin domæner leveres: - Python - C - C ++ - JavaScript - reStructuredText
• Den gamle markup til at definere og linker til C-direktiver vil ikke arbejde længere uden at aktivere `` oldcmarkup`` forlængelse.
• Fjernet støtte for gamle afhængighed versioner.
• Fjernet forældede elementer.

Hvad er nyt i version 0.6.5:

• I AutoDoc fastsætte udeladelse af nogle modul medlemmer udtrykkeligt dokumenteret ved hjælp af dokumentation kommentarer.
• Fix beskæring af sidebjælken rullepanel med `` stickysidebar`` mulighed for standard tema.
• generere altid UNIX nye linjer i quickstart Makefile.
• Fix køre med `` -C`` under Windows.
• I AutoDoc, tillade tilpasse undertegnelsen af ​​en genstand, hvor den indbyggede mekanisme mislykkes.
• Fix output for opregnede lister med startværdier i LaTeX.
• Gør `` start-after`` og `` end-before`` muligheder til `` literalinclude`` direktiv arbejde korrekt, hvis ikke bruges sammen.
• Fix link generation i LaTeX bygherre.

Hvad er nyt i version 0.6.4:

• Forbedret håndtering af ikke-Unicode-strenge i konfigurationen.
• Catch OSErrors forekommende, når du ringer graphviz med argumenter, ikke forstår.
• Gendan kompatibilitet med Pygments & gt;. = 1,2
• Fix flygter af hyperref mål i LaTeX output.
• Fix links genereres af ``: doc:. `` Rolle for LaTeX output
• Saml todo knuder efter hele dokumentet er læst; dette gør det muligt at placere substitution referencer i todo poster.
• Du må ikke ignorere en udtrykkelig `` today`` config værdi i en LaTeX build.
• `` alt`` tekst af arve- diagrammer er nu meget renere.
• Ignorer billeder i afsnittet titler, når genererer link billedtekster.
• Support undtagelse beskeder i `` testoutput`` blokke af `` doctest`` udvidelse.
• Linje blokke er stylet korrekt i HTML-output.
• Gjort `` locale_dirs`` config værdi arbejde igen.
• `` html_context`` værdier givet på kommandolinjen via `` -A`` bør ikke tilsidesætte andre værdierne i conf.py.
• Løs et bug forhindrer trinvise gendannelser til `` dirhtml`` bygherre.
• Fastgør rulning af citater i nogle bogstavelig blokke.
• Fix sti til søgeindekset for `` dirhtml`` bygherre.
• Løs et Jython kompatibilitet problem: gøre afhængigheden af ​​den `` parser`` modul valgfri
.
• I AutoDoc, fange alle fejl, der forekommer på modul import, ikke bare `` ImportError``.
• Fastgør håndtering af ikke-data, men ikke-metode deskriptorer i AutoDoc.
• Når du kopierer filer gange, ignorere OSErrors rejst af `` os.utime () ``.

Krav :

• Pygments 1.2 eller højere
• Jinja 2.3 eller højere
• Docutils 0/7 eller højere