Sphinx

Als gemaakt voor de eerste keer, is het belangrijkste doel was om te dienen als een documentatie generator voor het Python 's eigen code.
Sindsdien heeft het project cultstatus in de ontwikkeling wereld bereikte, als een van de meest verwezen invloeden in de meeste automatische documentatie generators rond, ongeacht de taal.
Tegenwoordig dan alleen Python, Sphinx kunnen ook worden gebruikt met C en C ++ code ook.

Wat is nieuw in deze release:

• Voeg gemak richtlijnen en rollen aan de C ++ domeinnaam: richtlijn `` CPP: var`` als alias voor `` CPP: member``, rol ``: CPP: var`` als alias voor ``: CPP: lid ``, en de rol van `any` voor cross-verwijzing naar een C ++ declaraction.
• De: confval: `source_suffix` config waarde kan nu een lijst met meerdere achtervoegsels zijn
.
• Voeg de mogelijkheid om de bron parsers opgeven door bron suffix met de: confval:. `Source_parsers` config waarde
• Een nieuwe bouwer, AppleHelpBuilder, is toegevoegd dat Apple Help Boeken bouwt.

Wat is nieuw in versie 1.2.3 / 1.3b3:

• Toegevoegd `` sphinx.version_info`` tuple voor programmatische controle van de Sphinx-versie.

Wat is nieuw in versie 1.1.3:

• Fixed crash met een aantal instellingen van: confval:. `Modindex_common_prefix`
• Vast afhandeling van `` -D`` en `` -A`` opties op Python 3.
• Erkend en waarschuwen ronde toctrees, in plaats van lopen in recursie fouten.
• compatibiliteit Restore met docutils kofferbak.
• Vast HTMLHelp indexingang koppelingen weer.
• Vast inheritance_diagram verhogen attribuut fouten op builtins.
• Vast crashes bij het aantrekken opmerkingen of eenzame termen in een woordenlijst.
• Vast HTML Help Taal / encoding mapping voor alle Sphinx ondersteunde talen.

Wat is nieuw in versie 1.1:

• Features toegevoegd:
• Toegevoegd Python 3.x ondersteuning.
• Nieuwe bouwers en subsysteem.
• incompatibele wijzigingen:
• De: eerste: dir: `py: module` richtlijn doet niet uitgevoerd zijn` `platform`` optie waarde meer. (Het was het enige dat de richtlijn deed output, en daarom zeer inconsistent.)
• verwijderd ondersteuning voor oude afhankelijkheid versies.
• Nieuwe locales:
• Toegevoegd Zweedse locale.
• Toegevoegd Iraanse locale.
• Toegevoegd Letse locale.
• Toegevoegd Nepali locale.
• Toegevoegd Koreaanse locale.
• Toegevoegd Estse locale.

Wat is nieuw in versie 1.0.8:

• Fix tracebacks voor AttributeErrors in autosummary generatie.
• Maak de `` abbr`` rol als de afkorting heeft nieuwe regels in het.
• Bevestig de links om resultaten met typen aangepaste object te zoeken.
• Fix lijnnummers gemeld in waarschuwingen over undefined gevonden.
• Fix C ++ scala definities en template argumenten die geen namen typen.
• Laat de voetnoten in hoofdstuk headers in LaTeX output.
• Laat zoekwoorden worden gekoppeld via intersphinx.
• Laat Unicode-tekens in de productie lijst token namen.
• Voeg dummy bezoekers voor graphviz knooppunten voor de tekst en de mens.
• Fix beeldbestand duplicatie bug.
• Fix parsing van meerdere handtekeningen in C ++ domein.
• Negeer Emacs lock-bestanden bij het zoeken naar de bronbestanden.
• Laat .pyw extensie voor importeerbare modules in AutoDoc.
• Gebruik `` $ (MAKE) `` in-quickstart gegenereerde Makefiles.
• Maak de zijbalk zoekvak breedte consistent in browsers.
• Fix afstand van gecentreerd figuren in HTML-uitvoer.
• veilig coderen SphinxError berichten wanneer ze afdrukken naar sys.stderr.
• Fix LaTeX output error met een document zonder secties, maar een link doelwit.
• Correct behandelen ingebouwde methode descriptoren als methoden AutoDoc.
• Stoppen monkeypatching de Python Tekstomloop module.
• Viewcode werkt nu correct met bronbestanden die niet-ASCII-codering.
• Respecteer de `` noindex`` vlag optie py:. Module richtlijnen
• Fix IndexErrors wanneer inclusief niet-bestaande lijnen met: eerste: dir:. `Literalinclude`
• Respect aangepaste functie / methode parameter separator strings.
• Fix JS onverenigbaarheid met jQuery & gt;. = 1,5
• Fix dubbele encoding gedaan bij het schrijven HTMLHelp .hhk bestanden.
• Niet SmartyPants toepassing ontleed-letterlijke blokken.
• C ++ domeinnaam ondersteunt nu reeks definities.

Wat is nieuw in versie 1.0.6:

• Fix traceback in Python domein voor lege kruisverwijzingen doelstellingen.
• Fix letterlijke blokweergave problemen op Chrome browsers.
• Ondersteuning sorteren van een beperkt aantal tekens met accenten in de algemene index en de woordenlijst.
• Probeer het decoderen `` -D`` en `` -A`` command-line argumenten met geprefereerde codering van de locale's.
• Let op: confval:. `Locale_dirs` bij het zoeken naar de JS vertalingen bestand
• Voeg speciale code voor een betere ondersteuning van de Japanse documenten in de latex bouwer.
• Regressie van # 77: Als er slechts één parameter gegeven met ``: param:. `` Markup, de kogel lijst is nu weer onderdrukt
• Fix ontbrekende paragraaf breuken in LaTeX output in bepaalde situaties.
• Emit de `` AutoDoc-proces-docstring`` evenement nog voor objecten zonder docstring zodat het inhoud kunt toevoegen.
• In de LaTeX bouwer, niet alleen letterlijk blokken vereisen verschillende tafel hanteren, maar ook heel wat andere lijst-achtige block elementen.
• Fix tracebacks in de viewcode extensie voor Python objecten die geen geldige handtekening hebben.
• Fix vreemde meldingen van de lijn nummers voor waarschuwingen gegenereerd uit-AutoDoc opgenomen docstrings, als gevolg van verschillende gedragingen, afhankelijk van docutils versie.
• Een aantal fixes aan de C ++ domein.

Wat is nieuw in versie 1.0.5:

• Voeg CSS-stijlen die door docutils 0,7 voor uitgelijnde beelden en cijfers.
• In de Makefile gegenereerd door LaTeX output, hoeft pdf-bestanden op schone niet verwijderen; ze zouden kunnen worden verplicht beelden.
• Fix LaTeX uitvoer gegenereerd voor lijn blokken.
• Laat `` .pyw`` als bron extensie.

Wat is nieuw in versie 1.0.4:

• Open intersphinx voorraden in de binaire modus op Windows, sinds versie 2 bevat zlib-gecomprimeerde data.
• Laat het geven van niet-lokale URI's voor de JavaScript-bestanden, bijvoorbeeld in de jsMath extensie.
• Fix traceback als `` intersphinx_mapping`` is leeg.

Wat is nieuw in versie 1.0.3:

• Fix interne vs. Externe link onderscheiding voor koppelingen uit een docutils table-of-inhoud.
• Maak de `` maxdepth`` optie voor de `` toctree () `` template opvraagbaar bij gebruik met `` ineenstorting = True``.
• Fix crash parsing Python argument lijsten met beugels in string literals.
• Fix regressie bij het bouwen van LaTeX documenten met cijfers die niet bijschriften hebben.
• Fix erfenis schema's voor de klassen die niet picklable.
• Introduceer aparte achtergrondkleur voor de zijbalk ineenstorting knop, waardoor het makkelijker wordt om te zien.
• Fix kleine lay-out bugs in verschillende ingebouwde thema's.

Wat is nieuw in versie 1.0.2:

• Fix kruisverwijzingen naar objecten van de soorten toegevoegd door: func:. `~ .Sphinx.add_object_type` API-functie
• Fix afhandeling van types doc veld voor verschillende soorten richtlijn.
• Laat breken lange handtekeningen, doorgaan met-backlash ontsnapte nieuwe regels.
• Fix ongewenste styling van C-domein referenties (vanwege een namespace botsing met Pygments stijlen).
• Laat verwijzingen naar PEPs en RFC's met expliciete ankers.
• Fix LaTeX verwijzingen naar de cijfers.
• Bij het doen van een niet-exact zoeken, alleen de wedstrijd bepaald type object.
• Breng niet-exact zoeken voor Python verwijzing doelen met `` .name`` voor modules ook.
• Fix crash bij het dupliceren van een parameter in een info veld lijst.
• Fix het instellen van de standaard rol om één door de `` oldcmarkup`` extensie.
• Fix crash bij JSON-py is geïnstalleerd, die een `` json`` module biedt, maar is onverenigbaar simplejson.
• Fix afhandeling van target benoemen in intersphinx.
• Fix verwijderen van ``! `` Voor alle kruisverwijzingen rollen.

Wat is nieuw in versie 1.0.1:

• Fix gegenereerd doelwit namen voor rust domeinnaam objecten; ze zijn niet in dezelfde naamruimte.
• Voeg Bengaalse taal.
• Een bug in het ontleden van JavaScript-object namen.
• Fix gebouw met SingleHTMLBuilder wanneer er geen toctree.
• Fix scherm namen voor objecten verbonden door intersphinx met expliciete doelstellingen.
• Bevestig het bouwen met de JSON bouwer.
• Fix hyperrefs in omschrijvingen object voor latex.

Wat is nieuw in versie 1.0:

• Algemeen:
• Voegde een "nitpicky" modus die waarschuwingen voor alle ontbrekende referenties uitzendt. Het wordt geactiveerd door het: optie: `-n` command-line switch of: confval:.` Nitpicky` config waarde
• Toegevoegd `` latexpdf`` doel in quickstart Makefile.
• Markup:
• De: eerste: de rol: `menuselection` en: eerste: de rol:.` Guilabel` rollen ondersteunen nu ampersand versnellers
• Nieuwe compactere doc veld syntax wordt nu erkend: ``: soort param name:. Description``
• Toegevoegd `` tab-width`` optie om: eerste: dir:. `Literalinclude` richtlijn
• Toegevoegd `` titlesonly`` optie om: eerste: dir:. `Richtlijn toctree`
• Toegevoegd de `` prepend`` en `` append`` opties om de: eerste: dir:. `Literalinclude` richtlijn
• Alle docinfo metadata is nu in het document metadata te zetten, niet alleen de auteur.
• De: eerste: de rol: `ref` rol kan nu ook tafels verwijzen door caption
.
• De: eerste: dir:. `Include` richtlijn ondersteunt nu absolute paden, die worden geïnterpreteerd als ten opzichte van de bron directory
• In de Python domein, referenties als ``: func:. `.name``` Nu op zoek naar overeenkomende namen met elk voorvoegsel als er geen directe match wordt gevonden
• Configuratie:
• Toegevoegd: confval:. `Rst_prolog` config waarde
• Toegevoegd: confval:. `Html_secnumber_suffix` config waarde sectie nummering formaat controle
• Toegevoegd: confval:. `Html_compact_lists` config waarde te controleren compact lijsten docutils 'kenmerken
• De: confval: `html_sidebars` config waarde kan nu bevatten patronen als sleutels en de waarden kunnen worden lijsten die expliciet selecteren welke sidebar templates moeten worden gemaakt. Dat betekent dat de ingebouwde inhoud zijbalk alleen selectief kan worden opgenomen.
• : confval:. `Html_static_path` kan nu enkel bestand vermeldingen bevatten
• De nieuwe universele config waarde: confval: `exclude_patterns` maakt de oude: confval:` unused_docs`,: confval: `exclude_trees` en: confval:.` Exclude_dirnames` verouderde
• Toegevoegd: confval:. `Html_output_encoding` config waarde
• de Toegevoegd: confval: `latex_docclass` config waarde en maakte de" twoside "documentclass optie Overridable door" oneside "
.
• de Toegevoegd: confval:. `Trim_doctest_flags` config waarde, dat is waar standaard
• Toegevoegd: confval:. `Html_show_copyright` config waarde
• Toegevoegd: confval: `latex_show_pagerefs` en: confval:.` Latex_show_urls` config waarden
• Het gedrag van: confval: `html_file_suffix` veranderde iets: de lege string betekent nu" geen achtervoegsel "in plaats van" default achtervoegsel ", gebruik` `None`` voor" default achtervoegsel "
.
• Nieuwe bouwers:
• toegevoegd een aannemer voor het epub-formaat.
• toegevoegd een bouwer voor handmatige pagina's.
• Toegevoegd een single-bestand HTML-bouwer.
• HTML output:
• Inline rollen krijgen nu een CSS-klasse met hun naam, waardoor stijlen om hun uiterlijk aan te passen. Domein-specifieke rollen krijgt twee klassen, `` domain`` en `` domein rolename``.
• Referenties krijgen nu de klasse `` internal`` als ze intern in het hele project, in tegenstelling tot de interne naar de huidige pagina.
• Externe referenties kunnen anders worden ingericht met de nieuwe `` externalrefs`` thema optie voor de standaard thema.
• In de standaard thema, de zijbalk kan experimenteel nu worden inklapbare gemaakt met behulp van de nieuwe `` collapsiblesidebar`` thema optie.
• Toctrees worden nu verpakt in een `` div`` tag met klasse `` toctree-wrapper`` in HTML-uitvoer.
• De: gegevens:. `Toctree` callable in templates heeft nu een` `maxdepth`` keyword argument om de diepte van de gegenereerde boom controle
• De: gegevens:. `Toctree` callable in templates een` `titles_only`` keyword argument accepteert nu
• Toegevoegd `` htmltitle`` blok in de lay-out sjabloon.
• In de JavaScript zoeken, maken het zoeken naar namen object inclusief de module naam, zoals `` sys.argv``.
• Toegevoegd nieuw thema `` haiku``, geïnspireerd door de Haiku OS handleiding.
• Toegevoegd nieuw thema `` nature``.
• Toegevoegd nieuw thema `` agogo``, gecreëerd door Andi Albrecht.
• Toegevoegd nieuw thema `` scrolls``, gecreëerd door Armin Ronacher.
• Toegevoegd een `` visitedlinkcolor`` thema optie om de standaard thema.
• Verbeterde responsiviteit van de zoekpagina door het laden zoektrocht index asynchroon.
• Uitbreiding API:
• Toegevoegd: event:. `Html-collect-pages`
• Toegevoegd: confval: `needs_sphinx` config waarde en: meth.` ~ Sphinx.application.Sphinx.require_sphinx` applicatie API-methode
• Toegevoegd: meth. `~ Sphinx.application.Sphinx.add_stylesheet` applicatie API-methode
• Extensies:
• de Toegevoegd: mod: `~ sphinx.ext.viewcode` uitbreiding
.
• de Toegevoegd: mod: `~ sphinx.ext.extlinks` uitbreiding
.
• Ondersteuning voor bron bestellen van leden in AutoDoc, met `` autodoc_member_order = 'bysource'``.
• Toegevoegd: confval:. `Autodoc_default_flags` config waarde, die kan worden gebruikt om standaard vlaggen selecteren voor alle AutoDoc richtlijnen
• toegevoegd een manier voor intersphinx te verwijzen naar de naam labels in andere projecten, en aan het project dat u wilt koppelen aan te geven.
• AutoDoc kunnen nu documenteren bijvoorbeeld attributen toegewezen in `` __init__`` methoden.
• Veel verbeteringen en oplossingen voor de: mod:. `~ Sphinx.ext.autosummary` uitbreiding, dankzij Pauli Virtanen
• De: mod: `~ sphinx.ext.graphviz` uitbreiding kunnen nu uitgang SVG in plaats van PNG-afbeeldingen, gecontroleerd door de confval:.` Graphviz_output_format` config waarde
• Toegevoegd `` alt`` optie om: eerste: dir:. `Graphviz` uitbreiding richtlijnen
• Toegevoegd `` exclude`` argument: func:. `.autodoc.between`
• Vertalingen:
• Toegevoegd Kroatische vertaling, dankzij Bojan Mihelac.
• Toegevoegd Turkse vertaling, dankzij Firat Ozgul.
• vertaling Toegevoegd Catalan, dankzij Pau Fernandez.
• Toegevoegd vereenvoudigd Chinese vertaling.
• Toegevoegd Deense vertaling, dankzij Hjorth Larsen.
• Toegevoegd Litouws vertaling, dankzij Dalius Dobravolskas.

Wat is nieuw in versie 1.0b1:

• Ondersteuning voor domeinen is toegevoegd. Een domein is een verzameling van richtlijnen en de rollen die alle beschrijven objecten bij elkaar horen, bijvoorbeeld elementen van een programmeertaal. Een paar ingebouwde domeinen worden geleverd: - Python - C - C ++ - JavaScript - reStructuredText
• De oude opmaak voor het definiëren en linken naar C richtlijnen niet meer zal werken zonder het activeren van het `` oldcmarkup`` extensie.
• verwijderd ondersteuning voor oude afhankelijkheid versies.
• Removed afgekeurde elementen.

Wat is nieuw in versie 0.6.5:

• In AutoDoc, fix het weglaten van bepaalde module leden expliciet gedocumenteerd met behulp van de documentatie opmerkingen.
• Fix bijsnijden van sidebar schuifbalk met `` stickysidebar`` optie van de standaard thema.
• genereren Altijd UNIX nieuwe regels in de quickstart Makefile.
• Fix lopen met `` -C`` onder Windows.
• In AutoDoc, laat aanpassen van de ondertekening van een object waar de ingebouwd mechanisme mislukt.
• Fix uitgang voor genoemde lijsten met start waarden in latex.
• Maak de `` start-after`` en `` end-before`` opties om de `` literalinclude`` richtlijn correct werken als het niet samen worden gebruikt.
• Fix koppeling generatie in de latex bouwer.

Wat is nieuw in versie 0.6.4:

• Verbeterde behandeling van niet-Unicode-strings in de configuratie.
• Catch OSErrors optreedt bij het aanroepen graphviz met argumenten die zij niet begrijpt.
• compatibiliteit Restore met Pygments & gt;. = 1,2
• Fix ontsnappen van hyperref doelen in LaTeX output.
• Fix koppelingen gegenereerd door de ``: doc:. `` Rol voor LaTeX uitgang
• Verzamelen todo knooppunten nadat het hele document is gelezen; dit maakt het plaatsen van substitutie verwijzingen in todo items.
• Gebruik een expliciete `` today`` config waarde in een LaTeX build niet negeren.
• De `` alt`` tekst van de erfenis schema is nu veel schoner.
• Negeer afbeeldingen in sectie titels bij het genereren van koppeling bijschriften.
• Ondersteuning uitzondering berichten in de `` testoutput`` blokken van de `` doctest`` extensie.
• Line blokken zijn goed ingericht in HTML-uitvoer.
• Made de `` locale_dirs`` config waarde weer aan het werk.
• `` html_context`` waarden op de opdrachtregel via `` -A`` mag geen andere waarden gegeven in conf.py overschrijven.
• Een bug voorkomen incrementele rebuilds voor de `` dirhtml`` bouwer.
• Bevestig de mangelen citaten in een aantal letterlijke blokken.
• Fix pad naar de zoekindex van de `` dirhtml`` bouwer.
• Een Jython compatibiliteitsprobleem: maak de afhankelijkheid van de `` parser`` module optioneel
.
• In AutoDoc, vangen alle fouten die voorkomen op de module import, niet alleen `` ImportError``.
• Bevestig de behandeling van niet-data, maar niet-methode descriptoren in AutoDoc.
• Bij het kopiëren van bestanden tijden, negeren OSErrors opgevoed door `` os.utime () ``.

Eisen

• Pygments 1.2 of hoger
• Jinja 2.3 of hoger
• Docutils 0/7 of hoger