Sphinx

Når laget for første gang, er det viktigste formålet var å tjene som en dokumentasjon generator for Python 's egen kode.
Siden den gang har prosjektet nådd kultstatus i utviklingen verden, være en av de mest refererte påvirkninger i de fleste automatiske dokumentasjon generatorer rundt, uavhengig av språk.
I dag er dessuten bare Python, Sphinx kan også brukes sammen med C og C ++ kode i tillegg.

Hva er nytt i denne versjonen:

• Legg convenience direktiver og roller til C ++ domene: Direktivet `` cpp: var`` som alias for `` cpp: member``, rollen ``: CPP: var`` som alias for ``: cpp: medlem ``, og rollen `any` for kryssreferanse til enhver C ++ declaraction.
• : confval: `source_suffix` config verdien kan nå være en liste over flere suffikser
.
• Legg muligheten til å spesifisere kilde parsere av kilde suffiks med: confval.: `Source_parsers` config verdi
• En ny byggmester, AppleHelpBuilder, har blitt lagt som bygger Apple Help Books.

Hva er nytt i versjon 1.2.3 / 1.3b3:

• Lagt `` sphinx.version_info`` tuppel for programma kontroll av Sphinx versjon.

Hva er nytt i versjon 1.1.3:

• Fast krasj med noen innstillinger av: confval.: `Modindex_common_prefix`
• Fast håndtering av `` -D`` og `` -A`` alternativer på Python tre.
• Anerkjent og advare om sirkulære toctrees, i stedet for å kjøre inn rekursjon feil.
• Gjenopprett kompatibilitet med docutils trunk.
• Faste Htmlhelp indeksoppføring lenker på nytt.
• Fast inheritance_diagram heve attributt feil på builtins.
• Faste krasjer når putting kommentarer eller lone termer i en ordliste.
• Fast HTML hjelp språk / koding kartlegging for alle Sphinx støttede språkene.

Hva er nytt i versjon 1.1:

• Funksjoner la til:
• Lagt Python 3.x støtte.
• Nye utbyggere og delsystem.
• Inkompatible endringer:
• : rst: dir: `py: module` direktivet ikke kan sende sin` `platform`` alternativ verdi lenger. (Det var det eneste som direktivet gjorde utgang, og derfor ganske inkonsekvent.)
• Fjernet støtte for gamle avhengighet versjoner.
• Nye steder:
• Lagt svenske locale.
• Lagt iranske locale.
• Lagt latvisk locale.
• Lagt Nepali locale.
• Lagt koreanske locale.
• Lagt Estonian locale.

Hva er nytt i versjon 1.0.8:

• Fix tracebacks for AttributeErrors i autosummary generasjon.
• Fest `` abbr`` rolle når forkortelsen har linjeskift i den.
• Fix lenkene for å søke resultater med egendefinerte objekttyper.
• Fix linje tall som er rapportert i advarsler om udefinerte referanser.
• Fix C ++ array-definisjoner og malparametere som ikke er typenavn.
• Tillat fotnoter i seksjon overskrifter i LaTeX utgang.
• Tillat søkeord for å bli koblet via intersphinx.
• Tillat Unicode-tegn i produksjon liste tokennavnene.
• Legg dummy besøkende for Graphviz noder for tekst og menneske.
• Fix bildefil duplisering feil.
• Fix analyseringen av flere signaturer i C ++ domene.
• Ignorer Emacs låse filer når vi leter etter kildefilene.
• Tillat .pyw forlengelse for import moduler i AutoDoc.
• Bruk `` $ (pass) `` i quickstart generert Make-filer.
• Gjør sidebar søkeboksen bredde konsekvent i nettlesere.
• Fix avstand sentrert tall i HTML-utgang.
• Trygg kode SphinxError meldinger når du skriver dem til sys.stderr.
• Fix LaTeX utgang feil med et dokument uten seksjoner, men en link mål.
• Korrekt behandling av innebygde metodebeskrivelser som metoder i AutoDoc.
• Stopp monkeypatching Python textwrap modulen.
• Viewcode fungerer nå riktig med kildefiler som har ikke-ASCII-koding.
• Respekter `` noindex`` flagg alternativ i py. Modul direktiver
• Fix IndexErrors når inkludert ikke-eksisterende linjer med: rst: dir.: `Literalinclude`
• Respekt tilpasset funksjons / metode parameter separator strenger.
• Fix JS inkompatibilitet med jQuery & gt;. = 1,5
• Fix dobbel koding gjort når du skriver Htmlhelp .hhk filer.
• Ikke påfør SmartyPants i analyseres-bokstavelige blokker.
• C ++ domene støtter nå array-definisjoner.

Hva er nytt i versjon 1.0.6:

• Fix traceback i Python domene for tomme kryssreferanse mål.
• Fix bokstave blokk visningsproblemer på Chrome nettlesere.
• Support sortering et begrenset utvalg av aksenttegn i den generelle indeksen og ordliste.
• Prøv å dekode `` -D`` og `` -A`` kommandolinjeargumenter med locale foretrukne koding.
• Observer: confval.: `Locale_dirs` når vi leter etter den JS oversettelser fil
• Legg spesiell kode for bedre støtte av japanske dokumenter i LaTeX byggherre.
• Regresjon av # 77: Hvis det bare er én parameter gitt med ``: param.: `` Markup, den punktliste er nå undertrykket igjen
• Fix mangler avsnittsskift i LaTeX produksjon i visse situasjoner.
• Emit den `` AutoDoc-prosess-docstring`` hendelsen selv for objekter uten en docstring slik at den kan legge til innhold.
• I LaTeX byggmester, ikke bare bokstavelig blokker krever annen tabell håndtering, men også ganske mange andre listelignende blokkelementer.
• Fix tracebacks i viewcode forlengelse for Python objekter som ikke har en gyldig signatur.
• Fix merkelige rapporteringer av linjenumre for advarsler generert fra AutoDoc-inkludert docstrings, på grunn av ulik atferd avhengig docutils versjon.
• Flere feilrettinger til C ++ domenet.

Hva er nytt i versjon 1.0.5:

• Legg til CSS-stiler som kreves av docutils 0,7 for stilte bilder og figurer.
• I Makefile generert av LaTeX-utgang, må du ikke slette pdf-filer på ren; de kan bli pålagt bilder.
• Fix LaTeX utgang generert for linjeblokker.
• Tillat `` .pyw`` som en kilde filtype.

Hva er nytt i versjon 1.0.4:

• Åpne intersphinx varelager i binær modus på Windows, siden versjon 2 inneholder zlib-komprimerte data.
• Tillat gi ikke-lokale URI for Javascript-filer, for eksempel i JSMath forlengelse.
• Fix traceback når `` intersphinx_mapping`` er tom.

Hva er nytt i versjon 1.0.3:

• Fix intern kontra ekstern lenke utmerkelse for koblinger som kommer fra en docutils table-of-contents.
• Fest `` maxdepth`` alternativ for `` toctree () `` mal oppsigelige når den brukes med `` kollaps = True``.
• Fix krasj parsing Python argumentlister som inneholder parentes i strenger.
• Fix regresjon når du bygger LaTeX dokumenter med tall som ikke har bildetekster.
• Fix arve diagrammer for klasser som ikke picklable.
• Innføre egen bakgrunnsfarge for sidepanelet kollaps knappen, noe som gjør det lettere å se.
• Fix små layout bugs i flere innebygde temaer.

Hva er nytt i versjon 1.0.2:

• Fix kryssreferanser til objekter av typer lagt til av: func.: `~ .Sphinx.add_object_type` API funksjon
• Fix håndtering av typer doc felt for ulike direktiv typer.
• Tillat bryte lange signaturer, fortsetter med tilbakeslag-rømt linjeskift.
• Fix uønsket styling av C domene referanser (på grunn av en navne sammenstøt med Pygments stiler).
• Tillat referanser til Peps og RFCs med eksplisitte ankere.
• Fix LaTeX referanser til tall.
• Når du gjør en ikke-eksakte søk, kamp kun gitt type objekt.
• Bruk ikke-eksakte søk etter Python referanse mål med `` .name`` for moduler også.
• Fix krasjer når du dupliserer en parameter i en info-feltet listen.
• Fix sette standard rollen til ett gitt av `` oldcmarkup`` forlengelse.
• Fix krasj når JSON-py er installert, noe som gir en `` json`` modul, men er uforenlig å simplejson.
• Fix håndtering av target navngi i intersphinx.
• Fix fjerning av ``! `` For alle kryssreferanse roller.

Hva er nytt i versjon 1.0.1:

• Fix genererte mål navn for hvile domene objekter; de er ikke i samme navnerom.
• Legg Bengali.
• Fix en bug i parsing Javascript-objektnavn.
• Fix bygge med SingleHTMLBuilder når det ikke er toctree.
• Fix visningsnavn for gjenstander knyttet til ved intersphinx med eksplisitte mål.
• Fix bygge med JSON byggherre.
• Fix hyperrefs i objektbeskrivelse for latex.

Hva er nytt i versjon 1.0:

• Generelt:
• Lagt til en "pirkete" -modus som sender ut advarsler for alle mangler referanser. Den aktiveres av: alternativ: `-n` kommandolinjebryter eller: confval.:` Nitpicky` config verdi
• Lagt `` latexpdf`` målet i quickstart Makefile.
• Markup:
• : rst: rolle: `menuselection` og: rst: rolle.:` Guilabel` roller støtter nå Ampersand akseleratorer
• New mer kompakt doc feltet syntaks er nå anerkjent: ``: param typenavn. Description``
• Lagt `` tab-width`` alternativ til: rst: dir.: `Literalinclude` direktiv
• Lagt `` titlesonly`` alternativ til: rst: dir.: `Toctree` direktiv
• Lagt `` prepend`` og `` append`` alternativer til: rst: dir.: `Literalinclude` direktiv
• All docinfo metadata er nå satt inn i dokumentet metadata, ikke bare forfatteren.
• : rst: rolle: `ref` rolle kan nå også referere tabeller ved bildetekst
.
• : rst: dir.: `Include` direktivet støtter nå absolutte stier, som er tolket som i forhold til kilden katalogen
• I Python domene, referanser som ``: func.: `.name``` Nå se etter samsvarende navn med prefiks hvis ingen direkte match er funnet
• Configuration:
• Lagd: confval.: `Rst_prolog` config verdi
• Lagd: confval.: `Html_secnumber_suffix` config verdi å kontrollere seksjon format nummerering
• Lagd: confval.: `Html_compact_lists` config verdi å kontrollere docutils 'kompakte lister har
• : confval: `html_sidebars` config verdien kan nå inneholde mønstre som nøkler, og verdiene kan være lister som eksplisitt velge hvilke sidebar maler skal gjengis. Det betyr at den innebygde sidebar innholdet kan inkluderes bare selektivt.
• : confval.: `Html_static_path` kan nå inneholde enkelt filoppføringer
• Den nye universal config verdi: confval: `exclude_patterns` gjør den gamle: confval:` unused_docs`,: confval: `exclude_trees` og: confval.:` Exclude_dirnames` foreldet
• Lagd: confval.: `Html_output_encoding` config verdi
• Lagt til: confval: `latex_docclass` config verdi og gjort" twoside "document alternativ overridable med" oneside "
.
• Lagt til: confval.: `Trim_doctest_flags` config verdi, som er sant som standard
• Lagd: confval.: `Html_show_copyright` config verdi
• Lagd: confval: `latex_show_pagerefs` og: confval.:` Latex_show_urls` config verdier
• Oppførselen til: confval: `html_file_suffix` endret litt: en tom streng nå betyr" nei suffiks "i stedet for" default suffiks ", bruk` `None`` for" default suffikset "
.
• Nye utbyggere:
• Lagt til en byggmester for Epub format.
• Lagt til en byggmester for manuelle sider.
• Lagt til en enkelt fil, HTML byggmester.
• HTML utgang:
• Inline roller får nå en CSS-klasse med navnet sitt, slik stiler å tilpasse deres utseende. Domenespesifikke roller får to klasser, `` domain`` og `` domene-rolename``.
• Referanser får nå klassen `` internal`` om de er interne til hele prosjektet, i motsetning til interne til den aktuelle siden.
• Eksterne referanser kan bli stylet annerledes med den nye `` externalrefs`` tema alternativ for standardtemaet.
• I standardtemaet, sidepanelet kan eksperimentelt nå gjøres sammen hjelp av den nye `` collapsiblesidebar`` tema alternativ.
• Toctrees er nå pakket inn i en `` div`` tag med klassen `` toctree-wrapper`` i HTML-utgang.
• : data.: `Toctree` oppsigelige maler nå har en` `maxdepth`` søkeord argument for å kontrollere dybden av den genererte treet
• : data.: `Toctree` oppsigelige maler nå aksepterer en` `titles_only`` søkeord argument
• Lagt `` htmltitle`` blokk i layout-mal.
• I Java søk, tillate søker etter objektnavn inkludert modulnavnet, som `` sys.argv``.
• Lagt nytt tema `` haiku``, inspirert av Haiku OS bruksanvisning.
• Lagt nytt tema `` nature``.
• Lagt nytt tema `` agogo``, skapt av Andi Albrecht.
• Lagt nytt tema `` scrolls``, laget av Armin Ronacher.
• Lagt til en `` visitedlinkcolor`` tema alternativ til standard tema.
• Forbedret respons på søkesiden ved å laste thesearch index asynkront.
• Extension API:
• Lagt: event.: `Html-collect-pages`
• Lagd: confval: `needs_sphinx` config verdi og: meth.:` ~ Sphinx.application.Sphinx.require_sphinx` søknad API metode
• Lagd: meth.: `~ Sphinx.application.Sphinx.add_stylesheet` søknad API metode
• Extensions:
• Lagt til: mod: `~ sphinx.ext.viewcode` forlengelse
.
• Lagt til: mod: `~ sphinx.ext.extlinks` forlengelse
.
• Lagt til støtte for kilde bestilling av medlemmer i AutoDoc, med `` autodoc_member_order = 'bysource'``.
• Lagd: confval.: `Autodoc_default_flags` config verdi, som kan brukes til å velge standard flagg for alle AutoDoc direktiver
• Lagt til en måte for intersphinx å referere til navngitte etiketter i andre prosjekter, og å angi prosjektet du vil koble til.
• AutoDoc kan nå dokumentere forekomst attributter tildelt i `` __init__`` metoder.
• Mange forbedringer og feilrettinger til: mod.: `~ Sphinx.ext.autosummary` forlengelse, takket være Pauli Virtanen
• : mod: `~ sphinx.ext.graphviz` forlengelse kan nå utgangs SVG i stedet for PNG-bilder, kontrollert av confval:.` Graphviz_output_format` config verdi
• Lagt `` alt`` alternativ til: rst: dir.: `Graphviz` skjøte direktiver
• Lagt `` exclude`` argument til: func.: `.autodoc.between`
• Oversettelser:
• Lagt kroatisk oversettelse, takket være Bojan Mihelac.
• Lagt tyrkisk oversettelse, takket være Firat Ozgul.
• Lagt katalansk oversettelse, takket være Pau Fernandez.
• Lagt forenklet kinesisk oversettelse.
• Lagt dansk oversettelse, takket være Hjorth Larsen.
• Lagt litauisk oversettelse, takket være Dalius Dobravolskas.

Hva er nytt i versjon 1.0b1:

• Støtte for domener har blitt lagt til. Et domene er en samling av direktiver og roller som alle beskriver objektene tilhørighet sammen, f.eks elementer av et programmeringsspråk. Noen builtin domener er gitt: - Python - C - C ++ - Javascript - reStructuredText
• Den gamle markering for å definere og koble til C-direktiver vil ikke fungere lenger uten å aktivere `` oldcmarkup`` forlengelse.
• Fjernet støtte for gamle avhengighet versjoner.
• Fjernet nedgraderte elementer.

Hva er nytt i versjon 0.6.5:

• I AutoDoc, fikse utelatelsen av noen modul medlemmer eksplisitt dokumentert ved hjelp av kommentarer dokumentasjon.
• Fix beskjæring av sidebar rullefeltet med `` stickysidebar`` muligheten til standardtemaet.
• Alltid generere UNIX linjeskift i quickstart Makefile.
• Fix kjører med `` -C`` under Windows.
• I AutoDoc, tillate tilpasse signaturen til et objekt der den innebygde mekanismen svikter.
• Fix utgang for oppregnet lister med startverdier i LaTeX.
• Gjør `` oppstart after`` og `` end-before`` alternativer til `` literalinclude`` direktivet fungere korrekt hvis den ikke brukes sammen.
• koblingen Løs generasjon i LaTeX byggmester.

Hva er nytt i versjon 0.6.4:

• Forbedret håndtering av ikke-Unicode-strenger i konfigurasjonen.
• Catch OSErrors oppstår når du ringer Graphviz med argumenter det ikke forstår.
• Gjenopprett kompatibilitet med Pygments & gt;. = 1.2
• Fix rømmer fra hyperref mål i LaTeX utgang.
• Fix lenker genereres av ``: doc.: `` Rolle for LaTeX utgang
• Samle todo noder etter at hele dokumentet er blitt lest; dette gjør plassere substitusjons referanser i todo elementer.
• Ikke overse en eksplisitt `` today`` config verdi i et LaTeX build.
• `` alt`` teksten i arve diagrammer er nå mye renere.
• Ignorer bildene i Overskriftene ved generering lenketekster.
• Support unntaks meldinger i `` testoutput`` blokker av `` doctest`` forlengelse.
• Linje blokker er stylet riktig i HTML-utgang.
• Gjort `` locale_dirs`` config verdi arbeid igjen.
• `` html_context`` verdier gitt på kommandolinjen via `` -A`` bør ikke overstyre andre verdiene gitt i conf.py.
• Fix en bug hindrer inkrementelle ombygginger for `` dirhtml`` byggmester.
• Fest rulling av sitater i noen bokstavelig blokker.
• Fix banen til søkeindeksen for `` dirhtml`` byggmester.
• Løs et Jython kompatibilitetsproblem: gjøre avhengigheten av `` parser`` modul valgfritt
.
• I AutoDoc, fange opp alle feil som oppstår på modulen import, ikke bare `` ImportError``.
• Fix håndtering av ikke-data, men ikke-metodebeskrivelser i AutoDoc.
• Når du kopierer filen ganger, ignorere OSErrors reist av `` os.utime () ``.

Krav

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