Sphinx

Wanneer geskep vir die eerste keer, dit is die hoof doel was om te dien as 'n dokumentasie generator vir Python se eie kode.
Sedertdien het die projek kultus status in die ontwikkeling wêreld bereik, wat een van die mees gekla invloede in die meeste outomatiese dokumentasie kragopwekkers om, ongeag van taal.
Vandag, behalwe net Python, Sphinx kan ook gebruik word met C en C ++ kode as well.

Wat is nuut in hierdie release:

• Voeg gerief riglyne en rolle van die C ++ domein: richtlijn `` CPP: var`` as alias vir `` CPP: member``, rol ``: CPP: var`` as alias vir ``: CPP: lid `` en die rol `any` vir kruis-verwysing na enige C ++ declaraction.
• Die: confval: `source_suffix` config waarde kan nou 'n lys van verskeie agtervoegsels wees
.
• Voeg die vermoë om die bron parsers spesifiseer deur die bron agtervoegsel met die: confval. `Source_parsers` config waarde
• 'n nuwe bouer, AppleHelpBuilder, is bygevoeg dat Apple Hulp Books bou.

Wat is nuut in weergawe 1.2.3 / 1.3b3:

• Bygevoeg `` sphinx.version_info`` tuple vir program kontrolering van die Sphinx weergawe.

Wat is nuut in weergawe 1.1.3:

• Vaste crash met 'n paar verstellings: confval. `Modindex_common_prefix`
• Vaste hantering van `` -D`` en `` -A`` opsies op Python 3.
• Erken en waarsku oor omsendbrief toctrees, in plaas van loop in rekursie foute.
• verenigbaarheid herstel met docutils stam.
• Vaste html help indeks inskrywing skakels weer.
• Vaste inheritance_diagram verhoging kenmerk foute op builtins.
• Vaste crashes wanneer om kommentaar of eensame terme in 'n woordelys.
• Vaste HTML hulp taal / encoding kartering vir alle Sphinx ondersteunde tale.

Wat is nuut in weergawe 1.1:

• funksies bygevoeg:
• Added Python 3.x ondersteun.
• New bouers en substelsel.
• Onversoenbare veranderinge:
• Die: eerste: dir: `py: module` richtlijn nie uitset sy` `platform`` opsie waarde nie. (Dit was die enigste ding wat die richtlijn het uitset, en daarom heel teenstrydig.)
• verwyder ondersteuning vir ou afhanklikheid weergawes.
• New locales:
• Bygevoeg Sweedse land.
• Bygevoeg Iraanse land.
• Bygevoeg Lets land.
• Bygevoeg Nepali land.
• Bygevoeg Koreaanse land.
• Bygevoeg Estonian land.

Wat is nuut in weergawe 1.0.8:

• Fix tracebacks vir AttributeErrors in autosummary geslag.
• Fix die `` abbr`` rol wanneer die afkorting het newlines in.
• Fix die skakels na resultate met tipes persoonlike voorwerp soek.
• Fix lyn nommers berig in waarskuwings oor undefined verwysings.
• Fix C ++ verskeidenheid definisies en template argumente wat nie name te tik.
• Laat voetnote in artikel headers in LaTeX uitset.
• Laat sleutelwoorde te word gekoppel via intersphinx.
• Laat Unicode karakters in die produksie lys token name.
• Voeg dummy besoekers vir graphviz nodes vir die teks en die mens.
• Fix beeld lêer duplisering fout.
• Fix parsing van verskeie handtekeninge in C ++ domein.
• Ignoreer Emacs slot lêers wanneer jy soek na die bron lêers.
• Laat .pyw verlenging vir invoerbare modules in autodoc.
• Gebruik `` $ (Maak) `` in-Quick gegenereer Makefiles.
• Maak sidebar soekkassie breedte konsekwent in blaaiers.
• Fix spasiëring van gesentreer figure in HTML-uitvoer.
• veilig enkodeer SphinxError boodskappe wanneer hulle druk om sys.stderr.
• Fix LaTeX uitset fout met 'n dokument met geen artikels, maar 'n skakel teiken.
• korrek te behandel ingeboude metode beskrywers as metodes in autodoc.
• Stop monkeypatching die Python textwrap module.
• Viewcode werk nou korrek met die bron lêers wat nie-ASCII encoding het.
• Respekteer die `` noindex`` vlag opsie in py. Module riglyne
• Fix IndexErrors wanneer insluitend nonexisting lyne met: eerste: dir. `Literalinclude`
• Respek persoonlike funksie / metode parameter separator snare.
• Fix JS onverenigbaarheid met jQuery & gt;. = 1,5
• Fix dubbel encoding gedoen word wanneer die skryf van html help .hhk lêers.
• Moenie Smarty toepassing in ontleed-letterlike blokke.
• C ++ domein ondersteun nou verskeidenheid definisies.

Wat is nuut in weergawe 1.0.6:

• Fix Stapelspoor in Python domein vir leë kruisverwysing teikens.
• Fix letterlike blok vertoon kwessies op Chrome blaaiers.
• Support sorteer 'n beperkte reeks van beklemtoonde karakters in die algemene indeks en die woordelys.
• Probeer dekodering `` -D`` en `` -A`` command-line argumente met voorkeur encoding die land se.
• Neem: confval. `Locale_dirs` wanneer jy soek vir die JS vertalings lêer
• Voeg spesiale kode vir beter ondersteuning van die Japannese dokumente in die LaTeX bouer.
• Regressie van # 77: As daar net een parameter gegee met ``: param. `` Opmaak, die koeël lys is nou weer onderdruk
• Fix ontbreek paragraaf breek in LaTeX uitset in sekere situasies.
• stoot die `` autodoc-proses-docstring`` geval selfs vir voorwerpe sonder 'n docstring sodat dit inhoud kan byvoeg.
• In die LaTeX bouer, nie net letterlike blokke vereis verskillende tafel hantering, maar ook 'n hele paar ander lys-agtige blok elemente.
• Fix tracebacks in die viewcode verlenging vir Python voorwerpe wat nie 'n geldige handtekening het nie.
• Fix vreemde aanmeldings lyn nommers vir waarskuwings gegenereer uit-autodoc ingesluit docstrings, as gevolg van verskillende gedrag afhangende docutils weergawe.
• Verskeie fixes die C ++ domein.

Wat is nuut in weergawe 1.0.5:

• Voeg CSS style vereis deur docutils 0,7 vir lyn beelde en figure.
• In die Make File gegenereer deur LaTeX uitset, moenie pdf lêers op skoon nie verwyder; hulle mag vereis beelde.
• Fix LaTeX uitset gegenereer lyn blokke.
• Laat `` .pyw`` as 'n bron lêer uitbreiding.

Wat is nuut in weergawe 1.0.4:

• Open intersphinx voorrade in binêre modus op Windows, sedert weergawe 2 bevat-zlib saamgeperste data.
• Laat gee nie-plaaslike URI vir JavaScript-lêers, bv in die JSMath uitbreiding.
• Fix Stapelspoor wanneer `` intersphinx_mapping`` is leeg.

Wat is nuut in weergawe 1.0.3:

• Fix interne teen eksterne skakel onderskeid vir die skakels kom uit 'n docutils tafel-of-inhoud.
• Fix die `` maxdepth`` opsie vir die `` toctree () `` sjabloon call able wanneer dit gebruik word met `` ineenstorting = True``.
• Fix crash parsing Python argument lyste met hakies in karkaterkonstantes.
• Fix regressie by die bou van LaTeX docs met syfers wat nie onderskrifte het nie.
• Fix erfenis diagramme vir klasse wat nie picklable.
• Stel afsonderlike agtergrond kleur vir die sidebar ineenstorting knoppie, maak dit makliker om te sien.
• Fix klein uitleg foute in verskeie ingeboude in temas.

Wat is nuut in weergawe 1.0.2:

• Fix kruis-verwysings na voorwerpe van tipes bygevoeg deur die: funk. `~ .Sphinx.add_object_type` API funksie
• Fix hantering van tipes doc veld vir verskillende tipes richtlijn.
• Laat breek lang handtekeninge, voort te gaan met-teenreaksie ontsnap newlines.
• Fix ongewenste stilering van C domein verwysings (as gevolg van 'n botsing met die naamruimte Pygments style).
• Laat verwysings na EPP's en RFCs met eksplisiete ankers.
• Fix LaTeX verwysings na figure.
• Wanneer 'n nie-presiese soek, wedstryd net die gegewe tipe voorwerp.
• Pas nie-presiese soek Python verwysing teikens met `` .name`` vir modules ook.
• Fix crash wanneer duplisering n parameter in 'n info field lys.
• Fix die opstel van die standaard rol een wat deur die `` oldcmarkup`` uitbreiding.
• Fix crash wanneer into-py geïnstalleer is, wat 'n `` json`` module bied, maar is in stryd met simplejson.
• Fix hantering van teiken noem in intersphinx.
• Fix verwydering van ``! `` Vir alle kruisverwysing rolle.

Wat is nuut in weergawe 1.0.1:

• Fix gegenereer teiken name vir rus domein voorwerpe; hulle is nie in dieselfde naamruimte.
• Voeg Bengali taal.
• Fix 'n fout in die ontleding van JavaScript voorwerp name.
• Fix bou met SingleHTMLBuilder wanneer daar geen toctree.
• Fix vertoning name vir voorwerpe gekoppel aan deur intersphinx met eksplisiete teikens.
• Fix bou met die into bouer.
• Fix hyperrefs in beskrywings voorwerp vir LaTeX.

Wat is nuut in weergawe 1.0:

• Algemeen:
• Bygevoeg 'n "nitpicky" af dat waarskuwings vir alle verwysings ontbreek straal. Dit word geaktiveer deur die: opsie: `-n` command-line skakelaar of die: confval.` Nitpicky` config waarde
• Bygevoeg `` latexpdf`` teiken in Quick Make File.
• Markup:
• Die: eerste: rol: `menuselection` en: eerste: rol:.` Guilabel` rolle ondersteun nou ampersand versnellers
• New meer kompak doc veld sintaksis word nou erken: ``: Tipe param name:. Description``
• Bygevoeg `` blad-width`` opsie om: eerste: dir. `Literalinclude` richtlijn
• Bygevoeg `` titlesonly`` opsie om: eerste: dir. `Richtlijn toctree`
• Bygevoeg die `` prepend`` en `` append`` opsies om die: eerste: dir. `Literalinclude` richtlijn
• Alle docinfo metadata is nou in die dokument metadata te stel, nie net die skrywer.
• Die: eerste: rol: `ref` rol kan nou ook tafels verwys deur titel
.
• Die: eerste: dir. `Include` richtlijn ondersteun nou absolute paaie, wat geïnterpreteer as relatief tot die bron gids
• In die Python domein verwysings soos ``: funk. `.name``` Nou kyk vir wat ooreenstem met die name met enige voorvoegsel indien geen direkte pasmaat gevind
• Configuration:
• Bygevoeg: confval. `Rst_prolog` config waarde
• Bygevoeg: confval. `Html_secnumber_suffix` config waarde artikel nommering formaat beheer
• Bygevoeg: confval. `Html_compact_lists` config waarde te beheer kompakte lyste docutils 'funksie
• Die: confval: `html_sidebars` config waarde kan nou bevat patrone as sleutels, en die waardes kan wees lyste wat uitdruklik kies watter sidebar templates moet gelewer word. Dit beteken dat die ingeboude inhoud sidebar slegs selektief ingesluit kan word.
• : confval. `Html_static_path` kan nou enkele lêer inskrywings bevat
• Die nuwe universele config waarde: confval: `exclude_patterns` maak die ou: confval:` unused_docs`,: confval: `exclude_trees` en: confval.` Exclude_dirnames` uitgediende
• Bygevoeg: confval. `Html_output_encoding` config waarde
• Bygevoeg die: confval: `latex_docclass` config waarde en het die" twoside "documentclass opsie overridable deur" oneside "
.
• Bygevoeg die: confval. `Trim_doctest_flags` config waarde, wat is waar by verstek
• Bygevoeg: confval. `Html_show_copyright` config waarde
• Bygevoeg: confval: `latex_show_pagerefs` en: confval.` Latex_show_urls` config waardes
• Die gedrag van: confval: `html_file_suffix` verander effens: die leë string beteken nou" geen agtervoegsel "in plaas van" default agtervoegsel ", gebruik` `None`` vir" standaard agtervoegsel "
.
• New bouers:
• Bygevoeg 'n bouer vir die Epub formaat.
• Bygevoeg 'n bouer vir die handleiding bladsye.
• Bygevoeg 'n enkel-lêer HTML bouer.
• HTML-uitvoer:
• Inline rolle kry nou 'n CSS klas met hul naam, sodat style om hul voorkoms te pas. Domain spesifieke rolle kry twee klasse, `` domain`` en `` domein rolename``.
• Verwysings kry nou die klas `` internal`` as hulle interne om die hele projek, in teenstelling met interne om die huidige bladsy.
• Eksterne verwysings kan anders styl met die nuwe `` externalrefs`` tema opsie vir die standaard tema.
• In die standaard tema, die sidebar kan eksperimenteel nou opvoubare gemaak met behulp van die nuwe `` collapsiblesidebar`` tema opsie.
• Toctrees nou toegedraai in 'n `` div`` tag met die klas `` toctree-wrapper`` in HTML-uitvoer.
• Die: data:. `Toctree` call able in templates het nou 'n` `maxdepth`` navraag argument om die diepte van die gegenereerde boom beheer
• Die: data:. `Toctree` call able in templates 'n` `titles_only`` navraag argument aanvaar nou
• Bygevoeg `` htmltitle`` blok in uitleg sjabloon.
• In die JavaScript soek, laat soek vir name voorwerp insluitende die module naam soos `` sys.argv``.
• Bygevoeg nuwe tema `` haiku``, geïnspireer deur die Haiku OS gebruikers handleiding.
• Bygevoeg nuwe tema `` nature``.
• Bygevoeg nuwe tema `` agogo``, geskep deur Andi Albrecht.
• Bygevoeg nuwe tema `` scrolls``, geskep deur Armin Ronacher.
• Bygevoeg 'n `` visitedlinkcolor`` tema opsie om die standaard tema.
• Verbeterde reaksie van die search bladsy deur die laai thesearch indeks asynchroon.
• Uitbreiding API
• Bygevoeg: gebeurtenis. `Html-Collect-pages`
• Bygevoeg: confval: `needs_sphinx` config waarde en: meth.` ~ Sphinx.application.Sphinx.require_sphinx` aansoek API metode
• Bygevoeg: meth. `~ Sphinx.application.Sphinx.add_stylesheet` aansoek API metode
• Uitbreidings:
• Bygevoeg die: mod: `~ sphinx.ext.viewcode` uitbreiding
.
• Bygevoeg die: mod: `~ sphinx.ext.extlinks` uitbreiding
.
• Bygevoeg ondersteuning vir bron bestel van lede in autodoc, met `` autodoc_member_order = 'bysource'``.
• Bygevoeg: confval. `Autodoc_default_flags` config waarde, wat gebruik kan word om die standaard vlae kies vir alle autodoc voorskrifte
• Bygevoeg 'n manier vir intersphinx om te verwys na die naam van etikette in ander projekte, en die projek wat jy wil om te skakel na spesifiseer.
• Autodoc kan nou dokumenteer byvoorbeeld eienskappe opgedra in `` __init__`` metodes.
• Baie verbeterings en fixes na die: mod. `~ Sphinx.ext.autosummary` uitbreiding, te danke aan Pauli Virtanen
• Die: mod: `~ sphinx.ext.graphviz` uitbreiding kan nou uitset SVG plaas van PNG beelde, beheer deur die confval.` Graphviz_output_format` config waarde
• Bygevoeg `` alt`` opsie om: eerste: dir. `Graphviz` uitbreiding voorskrifte
• Bygevoeg `` exclude`` argument: funk. `.autodoc.between`
• Translations:
• Bygevoeg Kroaties vertaling, te danke aan Bojan Mihelac.
• Bygevoeg Turkish vertaling, te danke aan Firat Ozgul.
• Vertaling bygevoeg Katalaans, te danke aan Pau Fernandez.
• Bygevoeg vereenvoudig Chinese vertaling.
• Bygevoeg Deense vertaling, te danke aan HJORTH Larsen.
• Bygevoeg Lithuanian vertaling, te danke aan Dalius Dobravolskas.

Wat is nuut in die weergawe 1.0b1:

• Ondersteuning vir domeine is bygevoeg. A domein is 'n versameling van voorskrifte en rolle wat al beskryf voorwerpe wat bymekaar hoort, bv elemente van 'n programmeertaal. 'N Paar ingeboude domeine word: - Python - C - C ++ - JavaScript - reStructuredText
• Die ou opmaak vir die definisie en 'n skakel na C voorskrifte sal nie meer werk nie sonder aktiveer die `` oldcmarkup`` uitbreiding.
• verwyder ondersteuning vir ou afhanklikheid weergawes.
• verwyder afgekeur elemente.

Wat is nuut in weergawe 0.6.5:

• In autodoc, los die weglating van sommige module lede uitdruklik gedokumenteer behulp dokumentasie kommentaar.
• Fix aanplanting van sidebar scroll bar met `` stickysidebar`` opsie van die standaard tema.
• genereer altyd UNIX newlines in die vinnig start Make File.
• Fix hardloop met `` -C`` onder Windows.
• In autodoc, laat die opstel van die ondertekening van 'n voorwerp waar die ingeboude meganisme versuim.
• Fix uitset vir vervat lyste met begin waardes in LaTeX.
• Maak die `` start-after`` en `` einde before`` opsies om die `` literalinclude`` richtlijn werk korrek indien nie saam gebruik word.
• Fix skakel generasie in die LaTeX bouer.

Wat is nuut in weergawe 0.6.4:

• Verbeterde die hantering van nie-Unicode snare in die opset.
• Catch OSErrors voorkom wanneer ek bel graphviz met argumente dit nie verstaan ​​nie.
• verenigbaarheid herstel met Pygments & gt;. = 1,2
• Fix ontsnapping van hyperref teikens in LaTeX uitset.
• Fix links gegenereer word deur die ``: doc. `` Rol vir LaTeX uitset
• versamel todo nodes na die hele dokument gelees; dit laat plaas vervanging verwysings in todo items.
• 'n eksplisiete `` today`` config waarde in 'n LaTeX bou nie ignoreer nie.
• Die `` alt`` teks van erfenis diagramme is nou baie skoner.
• Ignoreer beelde in artikel titels wanneer genereer skakel onderskrifte.
• Support uitsondering boodskappe in die `` testoutput`` blokke van die `` doctest`` uitbreiding.
• Line blokke behoorlik styl in HTML-uitvoer.
• Het die `` locale_dirs`` config waarde weer werk.
• `` html_context`` waardes wat op die command line via `` -A`` moet nie ander waardes wat in conf.py oorheers.
• Fix 'n fout voorkoming inkrementele rebuild vir die `` dirhtml`` bouer.
• Fix die mangling aanhalings in sommige letterlike blokke.
• Fix pad na die soek-indeks vir die `` dirhtml`` bouer.
• n Jython verenigbaarheid probleem: maak die afhanklikheid van die `` parser`` module opsionele
.
• In autodoc, vang al die foute wat voorkom op die invoer module, nie net `` ImportError``.
• Fix die hantering van nie-data, maar nie-metode beskrywers in autodoc.
• Wanneer kopiëring lêer keer ignoreer OSErrors wat deur `` os.utime () ``.

Vereistes :

• Pygments 1,2 of hoër
• Jinja 2,3 of hoër
• Docutils 0/7 of hoër