Sphinx

Kun luodaan ensimmäistä kertaa, sen pääasiallinen tarkoitus oli toimia dokumentaatio generaattori Python oman koodin.
Sittemmin hanke on saavuttanut kulttimaineen kehittämiseen maailmassa, on yksi kaikkein viitataan vaikutteita useimmissa automaattiset asiakirjoissa generaattorit ympärillä, kielestä riippumatta.
Tänään, lisäksi vain Python, sfinksi voidaan myös käyttää C ja C ++ koodia samoin.

Mikä on uusi tässä julkaisussa:

• Lisää mukavuutta direktiivit ja roolit C ++ domain: direktiivi `` CPP: var`` kuten alias `` CPP: member``, rooli ``: cpp: var`` kuten alias ``: cpp: jäsen ``, ja rooli `any` rajat viitata mihinkään C ++ declaraction.
• : confval: `source_suffix` config arvo voi nyt olla luettelo useista päätteitä.
• Lisää mahdollisuuden määritellä lähteeseen jäsentimiä lähteittäin Loppuosa: confval: `source_parsers` config-arvo.
• Uusi rakentaja, AppleHelpBuilder, on lisätty, joka rakentaa Apple Help Books.

Mikä on uusi versio 1.2.3 / 1.3b3:

• lisätyt `` sphinx.version_info`` monikko ohjelmalliseen tarkistamiseen sfinksi version.

Mikä on uusi versiossa 1.1.3:

• Kiinteät kaatuu joitakin asetuksia: confval: `modindex_common_prefix`.
• Kiinteä käsittely `` -D`` ja `` -A`` vaihtoehtoja Python 3.
• Tunnustettu ja varoittavat pyöreä toctrees sijaan ajautumassa rekursion virheitä.
• Palauta yhteensopivuus docutils runko.
• Kiinteät HTMLHelp hakemistomerkintään linkkejä uudelleen.
• Kiinteät inheritance_diagram nostaa määrite virheitä komennoista.
• Kiinteä kaatuu tehdessään huomautuksia tai yksinäinen termit sanastossa.
• Kiinteät HTML Help kieli / koodaus kartoitus kaikilla sfinksi tuettuja kieliä.

Mikä on uusi versio 1.1:

• Ominaisuudet lisätään:
• Lisätty Python 3.x tukea.
• Uusi rakentajia ja osajärjestelmän.
• Yhteensopimattomat muutokset:
• : rst: dir: `py: module` direktiivi ei tuotos sen` `platform`` option arvoa enää. (Se oli ainoa asia, että direktiivi ei tuotos, ja siksi varsin epäjohdonmukaista.)
• Poistettu tukea vanhojen riippuvuutta versioita.
• Uusi locales:
• Lisätty ruotsi locale.
• Lisätty Iranin maa.
• Lisätty Latvian maa.
• Lisätty Nepali maa.
• Lisätty Korean maa.
• Lisätty Viron maa.

Mikä on uusi versiossa 1.0.8:

• Korjaa tracebacks varten AttributeErrors vuonna autosummary sukupolvi.
• Kiinnitä `` abbr`` roolissa, kun lyhenne on rivinvaihdot siihen.
• Kiinnitä linkkejä hakutuloksiin mukautettuja objektityyppien.
• Korjaa Rivinumerot raportoitu varoituksia määrittelemätön viittauksia.
• Korjaa C ++ joukko määritelmiä ja mallin väitteitä, joita ei ole tyyppihyväksytty nimiä.
• Salli alaviitteet jaksossa otsikoiden LaTeX lähtö.
• Anna avainsanat voidaan liittää kautta intersphinx.
• Salli Unicode-merkkejä tuotannon luetteloon symbolinen nimiä.
• Lisää nuken kävijöitä GraphViz solmut tekstiä ja ihmisen.
• Korjaa kuvatiedoston päällekkäisyyksiä bug.
• Korjaa jäsennys useiden allekirjoitusten C ++ verkkotunnuksen.
• Ignore Emacs lukko tiedostoja etsiessään lähdetiedostot.
• Anna .pyw laajennus tuotavat moduulien AutoDoc.
• Käytä `` $ (MAKE) `` in quickstart luomaa Makefile.
• Tee sivupalkki hakukenttään leveys yhdenmukaisia ​​selaimissa.
• Korjaa väli keskitetty luvut HTML.
• Turvallisesti koodata SphinxError viestejä tulostettaessa niitä sys.stderr.
• Korjaa LaTeX tuotos virheestä asiakirjan ilman kohdat vaan linkin kohde.
• Oikein kohdella sisäänrakennettu menetelmässä kuvaajia kuin menetelmiä AutoDoc.
• Lopeta monkeypatching Python textwrap moduuli.
• Viewcode toimii nyt oikein lähdetiedostot, jotka ovat ei-ASCII-koodausta.
• Kunnioita `` noindex`` lippu vaihtoehto py: moduulissa direktiivit.
• Korjaa IndexErrors kun mukaan olemattomuus linjat: rst: dir: `literalinclude`.
• Respect räätälöinnillä / menetelmän parametri erotin narut.
• Korjaa JS yhteensopimattomuus jQuery & gt; = 1,5.
• Fix kaksinkertainen koodaus tehnyt kirjoittaessaan HTMLHelp .hhk tiedostoja.
• Älä käytä Smartypants in jäsennetään-kirjaimellisesti lohkoja.
• C ++ verkkotunnuksen tukee nyt joukko määritelmiä.

Mikä on uusi versiossa 1.0.6:

• Korjaa paluuseurannan Python verkkotunnuksen tyhjien ristiinviittaus tavoitteita.
• Fix kirjaimellinen lohkon näyttö kysymyksiä Chrome-selaimissa.
• Tuki lajittelu rajoitetun joukon aksenttimerkkejä yleisen indeksin ja sanasto.
• Kokeile dekoodaus `` -D`` ja `` -A`` komentorivin argumentit locale ensisijainen koodaus.
• Huomioi: confval: `locale_dirs` kun etsit JS käännösten tiedostoa.
• Lisää erityinen koodi parempaa tukea japanilaisten asiakirjojen LaTeX rakentaja.
• regressio # 77: Jos on vain yksi parametri annettiin ``: param: `` markup, luoti luettelo on nyt tukahdutettu uudelleen.
• Fix puuttuu kohta taukoja LaTeX lähtö tietyissä tilanteissa.
• Emit `` AutoDoc-prosessi-docstring`` tapahtuma edes objekteja docstring jotta se voi lisätä sisältöä.
• LaTeX rakentaja, ei pelkästään kirjaimellista lohkot vaativat erilaisia ​​pöydän käsittelyyn, vaan myös monen muun listan kaltaisia ​​block elementtejä.
• Fix tracebacks vuonna viewcode laajennus Python objekteja, joilla ei ole voimassa olevaa allekirjoitusta.
• Fix outo reportings linjan numerot varoituksista syntyvät AutoDoc-mukana docstrings, koska eri tavalla riippuen docutils versiosta.
• Useita korjauksia C ++ verkko.

Mikä on uusi versiossa 1.0.5:

• Lisää CSS-tyylejä vaatimat docutils 0,7 linjassa kuvien ja lukuja.
• Makefile syntyy LaTeX tuotos, älä poista pdf-tiedostoja puhtaiden; he saattavat olla tarpeen kuvaa.
• Korjaa LaTeX tulostus linjan lohkoja.
• Salli `` .pyw`` lähteenä tiedostopääte.

Mikä on uusi versiossa 1.0.4:

• Avaa intersphinx varastojen binäärimuodossa Windows, koska versio 2 sisältää zlib-pakattua tietoa.
• Salli antaa ei-paikallinen URI JavaScript-tiedostoja, kuten in JSMath laajennus.
• Korjaa paluuseurannan kun `` intersphinx_mapping`` on tyhjä.

Mikä on uusi versiossa 1.0.3:

• Korjaa sisäinen ja ulkoinen linkki ero linkeistä lähtöisin docutils table-of-sisältöä.
• Kiinnitä `` maxdepth`` vaihtoehto `` toctree () `` template vaadittaessa maksettavan kun käytetään `` romahtaa = True``.
• Korjaa kaatuu jäsennys Python argumenttilistat sisältävät Suluissa merkkijonon literaaleja.
• Korjaa regressio rakennettaessa LaTeX docs lukuja, jotka eivät ole kuvatekstejä.
• Korjaa perintö kaaviot luokkia, jotka eivät ole picklable.
• Esittele erilliset taustaväri sivupalkin romahtaa painiketta, jolloin se on helpompi nähdä.
• Fix pieniä asettelu bugeja useita sisäänrakennettuja teemoista.

Mikä on uusi versiossa 1.0.2:

• Fix viittauksia kohteet tyyppien lisännyt: toimin: `~ .Sphinx.add_object_type` API-toiminto.
• Korjaa käsittely doc kentän tyypit eri direktiivissä tyyppejä.
• Salli breaking pitkä allekirjoitukset, jatkaa takaisku-karannut rivinvaihdot.
• Fix toivottuja muotoilu C verkkotunnuksen viittauksia (koska nimiavaruus ristiriidassa Pygments tyylejä).
• Anna viittauksia toimeenpanopisteet ja RFC nimenomaisen ankkurit.
• Korjaa LaTeX viittauksia lukuihin.
• Kun teet kuin tarkka haku, ottelu vain tietyn objektin tyypin.
• Käytä ei-tarkka etsiä Python viite tavoitteiden kanssa `` .name`` moduuleja liikaa.
• Fix kaatua, kun päällekkäisiä parametrin info kenttää.
• Kiinnitä asettamalla oletuksena tehtävä toimittamaa `` oldcmarkup`` laajennus.
• Fix kaatua json-py on asennettu, joka tarjoaa `` json`` moduuli, mutta ei ole yhteensopiva sen simplejson.
• Korjaa käsittelyn kohteena nimeäminen on intersphinx.
• Korjaa poisto ``! `` Kaikki ristiinviittaus rooleja.

Mikä on uusi versiossa 1.0.1:

• Fix luotu tavoite nimiä lepoa domain esineitä; ne eivät ole samassa nimiavaruudessa.
• Lisää Bengali kieli.
• Fix bugi jäsentämiseen JavaScript objektien nimet.
• Fix rakennus SingleHTMLBuilder kun ei ole toctree.
• Fix näyttö nimet objektien liittyy vuoteen intersphinx kanssa yksiselitteiset tavoitteet.
• Kiinnitä rakennuksen JSON rakentaja.
• Korjaa hyperrefs objektikoodimuodossa kuvauksia LaTeX.

Mikä on uusi versiossa 1.0:

• Yleistä:
• Lisätty "nitpicky" -tila, joka päästää varoitukset kaikki puuttuvat viittaukset. Se aktivoidaan: vaihtoehto: '-n` komentorivivalitsinta tai: confval: `nitpicky` config-arvo.
• lisätyt `` latexpdf`` tavoite quickstart Makefile.
• Markup:
• : rst: rooli: `menuselection` ja: rst: rooli:` guilabel` roolit tukevat nyt -merkki kiihdyttimiä.
• Uusi kompakti doc kenttä syntaksi on nyt tunnustettu: ``: param tyyppi nimi: description``.
• lisätyt `` tab-width`` vaihtoehto: rst: dir: `literalinclude` direktiivi.
• lisätyt `` titlesonly`` vaihtoehto: rst: dir: `toctree` direktiivi.
• Lisätty `` prepend`` ja `` append`` vaihtoehtoja: rst: dir: `literalinclude` direktiivi.
• Kaikki docinfo metadata on nyt otettu dokumenttien metatietoja, ei vain kirjailija.
• : rst: rooli: `ref` rooli voi nyt myös viitata pöytiä kuvatekstin.
• : rst: dir: `include` direktiivi tukee nyt ehdoton polkuja, jotka tulkitaan suhteessa lähdehakemistoon.
• Python domain, viittauksia kuten ``: func: `.name``` nyt etsiä täsmäävät nimet tahansa etuliite jos suora osuma löytyy.
• Kokoonpano:
• Lisätty: confval: `rst_prolog` config-arvo.
• Lisätty: confval: `html_secnumber_suffix` config arvo hallita osio numeroinnin muodossa.
• Lisätty: confval: `html_compact_lists` config arvo valvoa docutils kompakti luetteloihin on.
• : confval: `html_sidebars` config arvo voi nyt olla kuvioita kuten avaimia, ja arvot voivat olla luetteloita, jotka nimenomaisesti valita sivupalkki malleja olisi tehtävä. Tämä tarkoittaa, että sisäänrakennettu sivupalkin sisältö voidaan sisällyttää vain valikoivasti.
• : confval: `html_static_path` voi nyt olla yksittäisen tiedoston merkinnät.
• Uusi yleinen config-arvo: confval: `exclude_patterns` tekee vanha: confval:` unused_docs`,: confval: `exclude_trees` ja: confval:` exclude_dirnames` vanhentunut.
• Lisätty: confval: `html_output_encoding` config-arvo.
• Lisätty: confval: `latex_docclass` config-arvon ja teki" twoside "documentclass vaihtoehto overridable mukaan" oneside ".
• Lisätty: confval: `trim_doctest_flags` config-arvo, joka on totta oletuksena.
• Lisätty: confval: `html_show_copyright` config-arvo.
• Lisätty: confval: `latex_show_pagerefs` ja: confval:` latex_show_urls` config arvoja.
• käyttäytymiseen: confval: `html_file_suffix` muuttui hieman: tyhjän merkkijonon nyt tarkoittaa" no pääte "eikä" default pääte ", käytä` `None`` for" default pääte ".
• Uusi rakentajat:
• Lisätty rakentaja Epub muotoa.
• Lisätty rakentaja manuaalisivujen.
• Lisätty yhden tiedoston HTML rakentaja.
• HTML:
• Inline rooleja nyt saada CSS luokan nimensä, jolloin tyylit muokata niiden ulkonäköä. Domain-erityinen rooleja saavat kaksi luokkaa, `` domain`` ja `` domain-rolename``.
• Viittaukset nyt saada luokan `` internal`` jos ne sisäisiä koko hankkeen, vastakohtana sisäinen nykyisen sivun.
• Ulkoiset viittaukset voidaan tyylistä eri tavoin uuteen `` externalrefs`` teema vaihtoehto oletusteemaa.
• oletusteemaa, sivupalkin voidaan kokeellisesti nyt tehdä kokoontaitettava käyttäen uutta `` collapsiblesidebar`` teema vaihtoehto.
• Toctrees nyt kääritty `` div`` tag luokan `` toctree-wrapper`` HTML lähtö.
• : tiedot: `toctree` vaadittaessa maksettavia in malleja nyt on` `maxdepth`` avainsanan argumentti valvoa syvyys syntyy puun.
• : tiedot: `toctree` vaadittaessa maksettavia in malleja hyväksyy nyt` `titles_only`` avainsanan argumentin.
• lisätyt `` htmltitle`` lohkon layout malli.
• JavaScript-haku, voi etsiä objektien nimet kuten moduulin nimi, kuten `` sys.argv``.
• Lisätty uusi teema `` haiku`` innoittamana Haiku OS käyttöohjeet.
• Lisätty uusi teema `` nature``.
• Lisätty uusi teema `` agogo`` luoma Andi Albrecht.
• Lisätty uusi teema `` scrolls`` luoma Armin Ronacher.
• Lisätty `` visitedlinkcolor`` teema vaihtoehto oletusteema.
• Parannettu reagointikykyä hakusivun kuormittamalla thesearch indeksin asynkronisesti.
• Extension API:
• Lisätty: tapahtuma: `html-kerätä-pages`.
• Lisätty: confval: `needs_sphinx` config-arvon ja: met:` ~ sphinx.application.Sphinx.require_sphinx` sovelluksen API menetelmällä.
• Lisätty: met: `~ sphinx.application.Sphinx.add_stylesheet` sovelluksen API menetelmällä.
• Laajennukset:
• Lisätty: mod: `~ sphinx.ext.viewcode` laajennus.
• Lisätty: mod: `~ sphinx.ext.extlinks` laajennus.
• Lisätty tuki lähde tilaaminen jäsenten AutoDoc, jossa `` autodoc_member_order = 'bysource'``.
• Lisätty: confval: `autodoc_default_flags` config-arvo, jota voidaan käyttää valitsemaan default liput kaikkien AutoDoc direktiiveihin.
• Lisätty tapa intersphinx viitata nimetty tarrat muissa hankkeissa, ja määrittää projektin haluat linkittää.
• AutoDoc nyt dokumentoida esimerkiksi attribuutteja osoitettu `` __init__`` menetelmiä.
• Monia parannuksia ja korjauksia: mod: `~ sphinx.ext.autosummary` laajennus, kiitos Pauli Virtanen.
• : mod: `~ sphinx.ext.graphviz` laajennus voi nyt tuotos SVG sijaan PNG kuvien, ohjataan confval:` graphviz_output_format` config-arvo.
• lisätyt `` alt`` vaihtoehto: rst: dir: `graphviz` laajennus direktiivejä.
• lisätyt `` exclude`` argumentti: func: `.autodoc.between`.
• Käännökset:
• Lisätty kroatia käännös, kiitos Bojan Mihelac.
• Lisätty turkki käännös, kiitos Firat Ozgul.
• Lisätty katalaani käännös, kiitos Pau Fernandez.
• Lisätty yksinkertaistettu kiina käännös.
• Lisätty tanska käännös, kiitos Hjorth Larsen.
• Lisätty liettua käännös, kiitos Dalius Dobravolskas.

Mikä on uusi versiossa 1.0b1:

• Tuki verkkotunnuksia on lisätty. Verkkotunnus on kokoelma direktiivejä ja rooleja, jotka kaikki kuvaavat esineet kuuluvat yhteen, kuten elementtejä ohjelmointikieli. Muutama builtin verkkotunnukset ovat: - Python - C - C ++ - JavaScript - reStructuredText
• vanha Markup määrittelyssä ja linkittävät C direktiivejä ei toimi enää aktivoimatta `` oldcmarkup`` laajennus.
• Poistettu tukea vanhojen riippuvuutta versioita.
• Poistettu vanhentunut elementtejä.

Mikä on uusi versiossa 0.6.5:

• AutoDoc, korjata laiminlyönti joidenkin moduulin jäsenistä selvästi dokumentoitu avulla asiakirjat kommentteja.
• Korjaa rajaus sivupalkissa scroll bar `` stickysidebar`` mahdollisuus oletusteemaa.
• Aina tuottaa UNIX rivinvaihtoja vuonna quickstart Makefile.
• Fix juoksemassa `` -C`` Windows.
• AutoDoc, anna räätälöintiä allekirjoitus objektin, jossa sisäänrakennettu mekanismi toimi.
• Korjaa ulostulo lueteltu luettelot alusta arvoja LaTeX.
• Tee `` alkavat-after`` ja `` end-before`` vaihtoehtoja `` literalinclude`` direktiivi toimi oikein, jos ei käytetä yhdessä.
• Korjaa -linkkiä sukupolven LaTeX rakentaja.

Mikä on uusi versiossa 0.6.4:

• Parannettu käsittely kuin Unicode merkkijonoja kokoonpanon.
• Catch OSErrors esiintyy soitettaessa GraphViz argumenteilla ei ymmärrä.
• Palauta yhteensopivuus Pygments & gt; = 1.2.
• Fix pakenevat of hyperref tavoitteita LaTeX lähtö.
• Fix luoduista ``: doc: `` rooli LaTeX lähdön.
• Kerää todo solmut kun koko asiakirja on luettu; Tämä mahdollistaa sijoittamalla korvaaminen viittauksia todo kohteita.
• Älä jätä nimenomaista `` today`` config arvo LaTeX rakentaa.
• `` alt`` teksti perintö kaavioita on nyt paljon puhtaampaa.
• Ignore kuvien otsikot luotaessa linkkiä kuvatekstejä.
• Support poikkeus viestejä `` testoutput`` lohkot `` doctest`` laajennus.
• Line lohkot tyylistä oikein HTML.
• Valmistettu `` locale_dirs`` config arvoa työn uudelleen.
• `` html_context`` arvoja komentorivillä kautta `` -A`` saisi syrjäyttää muita annettuja arvoja conf.py.
• Fix bugi estää vähitellen uusintoja varten `` dirhtml`` rakennusmestari.
• Kiinnitä asiallisesti lainausmerkkejä joidenkin kirjaimellisesti lohkoja.
• Korjaa polku hakuindeksin `` dirhtml`` rakennusmestari.
• Korjaa Jython yhteensopivuus ongelma: tee riippuvuus `` parser`` moduulin lisävarusteena.
• AutoDoc, kiinni kaikki virheet, jotka tapahtuvat moduuli tuontia, ei vain `` ImportError``.
• Kiinnitä käsittelyä ei-datan, mutta ei-menetelmällä kuvaajat AutoDoc.
• Kun kopioit tiedoston kertaa, sivuuttaa OSErrors esittämä `` os.utime () ``.

vaatimukset

• Pygments 1.2 tai uudempi
• Jinja 2.3 tai uudempi
• Docutils 0/7 tai korkeampi