Amikor létrehozta az első alkalommal, hogy fő célja az volt, hogy szolgáljon a dokumentáció készítő rendszer Python saját kódját.
Azóta, a projekt elérte kultikus státuszt a fejlesztés világban, hogy az egyik hivatkozott hatások A legtöbb automata dokumentáció generátorok körül, nyelvtől függetlenül.
Ma, mellett csak a Python, Sphinx is lehet használni a C és C ++ kód is.
Mi az új ebben a kiadásban:
- Add kényelmet irányelvek és szerepek a C ++ tartomány: irányelv `` cpp: var`` mint álneve `` cpp: member``, szerepe ``: cpp: var`` mint álneve ``: cpp: tag ``, és szerepet `any` a határokon hivatkozva a C ++ declaraction.
- A: confval: `source_suffix` config értéket lehet most egy listát több végződések.
- Adja hozzá a képessége, hogy meghatározzuk forrás értelmezők forrása szerint utótag a: confval: `source_parsers` config értéke.
- Egy új építője, AppleHelpBuilder, bővült, amely épít az Apple Help Books.
Mi az új verzióban 1.2.3 / 1.3b3:
- Added `` sphinx.version_info`` est, program ellenőrzését a Szfinx változat.
Mi az új verzióban 1.1.3:
- Fixed crash bizonyos beállításait: confval: `modindex_common_prefix`.
- Fix kezelése `` `` -D`` és -A`` opciók Python 3.
- Az elismert, és figyelmeztet körkörös toctrees helyett fut be rekurzív hibákat.
- Restore kompatibilitás docutils csomagtartóba.
- Fix HTMLHELP indexbejegyzés linkek újra.
- Fix inheritance_diagram emelése attribútum hibák builtins.
- Fix összeomlik, amikor üzembe megjegyzést vagy magányos értelemben egy szószedetet.
- Fix HTML súgó nyelve / kódolás mapping minden Sphinx támogatott nyelv.
Mi az új 1.1-es verzióban:
- Tulajdonságok hozzá:
- Added Python 3.x támogatást.
- New építők és az alrendszer.
- Összeférhetetlen változások:
- A: első: dir: `py: module` irányelv nem ad a` `platform`` opció értéke többé. (Ez volt az egyetlen dolog, hogy az irányelv nem kimenet, és ezért nagyon következetlen.)
- Az eltávolított támogatása a régi függőségi változat.
- új területek:
- Added svéd locale.
- Added iráni locale.
- Added lett locale.
- Added nepáli locale.
- Added koreai locale.
- Added észt locale.
Mi az új a 1.0.8 verzió:
- Fix tracebacks a AttributeErrors a Autosum generáció.
- Fix a `` abbr`` szerepet, amikor a rövidítés üres sorokat is.
- Fix a linkeket a keresés eredménye egyéni objektum típusok.
- Fix sorszámok jelentett figyelmeztetéseket meghatározatlan hivatkozásokat.
- Fix C ++ tömb definíciókat és a sablon érveket, amelyeket nem írja nevét.
- Allow lábjegyzetek szakaszfejlécekre a LaTeX kimenettel.
- Hagyjuk kulcsszavakat keresztül kapcsolódhat intersphinx.
- Allow Unicode karaktereket termelés lista token nevét.
- Add dummy látogatók számára Graphviz csomópontok a szöveges és az ember.
- Fix képfájl másolása bug.
- Fix elemzésekor több aláírás a C ++ területen.
- Ignore Emacs lock fájlokat keres forrás fájlokat.
- Hagyjuk .pyw kiterjesztése importkeresleti modulok autodoc.
- A `` $ (MAKE) `` a gyorsindító generált Makefiles.
- tálaló keresőmező szélességét következetes böngészőkben.
- Fix távolság központú számok HTML kimenetet.
- Biztonságosan kódolni SphinxError üzenetek nyomtatásakor őket sys.stderr.
- Fix LaTeX kimeneti hiba a dokumentum egyetlen szakaszt sem, de egy linket cél.
- helyesen kezelik beépített módszerét leíró mint módszerekkel autodoc.
- Ne monkeypatching a Python textwrap modul.
- Viewcode most jól működik forrás fájlokat, melyek nem ASCII kódolás.
- Tiszteld a `` noindex`` flag opciót py: modul irányelvek.
- Fix IndexErrors amikor beleértve nem létező vonalak: első: dir: `literalinclude`.
- Tisztelet egyéni függvény / eljárás paraméter elválasztó húrok.
- Fix JS inkompatibilitás jQuery & gt; = 1,5.
- Fix dupla kódolási tenni, ha írásban HTMLHelp .hhk fájlokat.
- Ne alkalmazza SmartyPants az elemzett szó szerinti blokkok.
- C ++ tartomány most már támogatja a tömb meghatározásokat.
Mi az új a 1.0.6 verzió:
- Fix lőfegyverét Python domain üres kereszt-referencia-célokat.
- Fix szó blokkok megjelenítését kérdések Chrome böngészőben.
- Támogatás válogatás korlátozott körű ékezetes karakterek az általános index és a gyűjteményt.
- Próbálj dekódolás `` `` -D`` és -A`` parancssori a locale által preferált kódolás.
- Vegye figyelembe: confval: `locale_dirs` amikor keresi a JS fordítások fájlt.
- Add speciális kódot jobban támogatja a japán dokumentumok a LaTeX építője.
- visszafejlődése # 77: Ha csak egy paraméter adott a ``: param: `` jelölő, a golyó lista most elnyomott újra.
- Fix hiányzik bekezdés szünetek LaTeX kimeneti bizonyos helyzetekben.
- autóról, a `` autodoc-folyamat-docstring`` esetén akár tárgyak nélkül docstring úgy, hogy új tartalommal.
- A LaTeX építő, nem csak szó szerinti blokkok igényelnek a különböző asztal kezelését, hanem jó néhány más listaszerű blokkot tartalmaz.
- Fix tracebacks a viewcode kiterjesztése Python objektumok, amelyek nem rendelkeznek érvényes aláírást.
- Fix furcsa reportings a vonalak számát a figyelmeztetések generált autodoc-szereplő docstrings, az eltérő viselkedés függően docutils változat.
- Több javítások a C ++ területen.
Mi az új verzióban 1.0.5:
- Add CSS stílusokat által megkövetelt docutils 0.7 igazított képek és adatok.
- A Makefile által generált LaTeX kimenet, ne törölje pdf fájlokat tiszta; esetleg szükség lehet a képeket.
- Fix LaTeX kimeneti keletkezett sorban blokkok.
- Allow `` .pyw`` forrásként fájl kiterjesztését.
Mi az új a 1.0.4 verzió:
- Megnyitás intersphinx készletek bináris módban Windows, mivel 2-es verzió tartalmaz zlib-tömörített adatok.
- Hagyjuk így nem helyi URI JavaScript fájlok, pl A JSMath kiterjesztése.
- Fix lőfegyverét, amikor `` intersphinx_mapping`` üres.
Mi az új a 1.0.3 verzió:
- Fix belső vs. külső link különbséget a linkek érkező docutils asztal-of-tartalmát.
- Fix a `` maxdepth`` lehetőség a `` toctree () `` template lehívható használata esetén `` összeomlása = True``.
- Fix összeomlás elemzés Python argumentumlista tartalmazó zárójelben sztring literálok.
- Fix regressziós kiépítése során LaTeX docs a számok, hogy nincs feliratokat.
- Fix öröklési rajzai osztályok, amelyek nem picklable.
- Tegyünk külön háttérszínt a tálaló összeomlás gombot, így könnyebben látni.
- Fix kis layout hibák számos beépített témák.
Mi az új a 1.0.2 verzió:
- Fix kereszthivatkozások tárgyak fajta által hozzáadott: funk: `~ .Sphinx.add_object_type` API funkciót.
- Fix kezelése doc mező tartalmazza a különböző típusú irányelvet.
- Allow törés hosszú aláírások, folytatva holtjáték-megszökött újsorok.
- Fix kívánt stílusa C domén referenciák (mert egy névtér összecsapást Pygments stílusok).
- engedélyezése hivatkozásokat PEP és RFC explicit horgonyt.
- Fix LaTeX hivatkozásokat számok.
- Ha csinálsz egy nem pontos keresés, meccs csak az adott típusú objektum.
- Apply nem pontos keresést Python referencia célokat `` .name`` a modulok is.
- Fix összeomlik, ha megkettőzése paraméterként egy info mezőlista.
- Fix beállítás alapértelmezett szerepe volt az egyhez, a `` oldcmarkup`` kiterjesztése.
- Fix összeomlik, ha json-py van telepítve, amely `` json`` modul, de nem kompatibilis a simplejson.
- Fix kezelését cél elnevezési a intersphinx.
- Fix eltávolítása '! `` Minden utalás szerepeket.
Mi az új a 1.0.1 verzió:
- Fix generált cél nevét a pihenésre tartomány tárgyak; ők nem ugyanabban a névtérben.
- Add bengáli nyelven.
- Hibajavítás az elemzés JavaScript objektum nevek.
- Fix épület a SingleHTMLBuilder ha nincs toctree.
- Fix megjelenítési neveket tárgyak kapcsolódnak a intersphinx a konkrét célkitűzéseket.
- Fix épület a JSON építője.
- Fix hyperrefs a tárgy leírását a LaTeX.
Mi az új 1.0 verzióban:
- Általános:
- hozzáadva a "nitpicky" mód, amely bocsát ki figyelmeztetést az összes hiányzó hivatkozásokat. Ez aktiválja a: lehetőség: `-n` parancssori kapcsoló vagy a: confval:` nitpicky` config értéke.
- Added `` latexpdf`` cél gyorstalpaló Makefile.
- Markup:
- A: első: szerepe: `menuselection` és: első: szerepe:` guilabel` szerepeket már támogatja jelet gyorsítók.
- New kompaktabb doc terén szintaxis ma már: ``: param típus neve: description``.
- Added `` fül-width`` opció: első: dir: `literalinclude` irányelv.
- Added `` titlesonly`` opciót: RST: dir: `toctree` irányelv.
- Hozzáadás a `` `` prepend`` és append`` lehetőségek az: RST: dir: `literalinclude` irányelv.
- Minden docinfo metaadatok most helyezni a dokumentum metaadatait, nem csak a szerző.
- A: első: szerepe: `ref` szerepe most is referencia táblázatok feliratot.
- A: első: dir: `include` irányelv már támogatja a teljes elérési utat, amely értelmezi képest a forrás könyvtárban.
- A Python domain, referenciák, mint a ``: funk: `.name``` most keresnek illeszkedő nevek bármilyen prefix, ha nincs közvetlen egyezést.
- Configuration:
- Added: confval: `rst_prolog` config értéke.
- Added: confval: `html_secnumber_suffix` config értékét, hogy ellenőrizzék a rész számozási formátumot.
- Added: confval: `html_compact_lists` config-érték ellenőrzésére docutils" kompakt listák található.
- A: confval: `html_sidebars` config értéke mostantól lehetnek mintákat kulcsokat, és az értékek lehetnek listák kifejezetten válassza ki tálaló sablonokat kell tenni. Ez azt jelenti, hogy a beépített tálaló tartalom lehet benne csak szelektíven.
- : confval: `html_static_path` mostantól lehetnek egyetlen fájl bejegyzéseket.
- Az új univerzális config értéke: confval: `exclude_patterns` teszi a régi: confval:` unused_docs`,: confval: `exclude_trees` és: confval:` exclude_dirnames` elavult.
- Added: confval: `html_output_encoding` config értéke.
- Hozzáadás a: confval: `latex_docclass` config értékét és így a" twoside "documentclass lehetőség felülírható a" oneside ".
- Hozzáadás a: confval: `trim_doctest_flags` config érték, ami igaz alapértelmezés szerint.
- Added: confval: `html_show_copyright` config értéke.
- Added: confval: `latex_show_pagerefs` és: confval:` latex_show_urls` config értékeket.
- A viselkedés: confval: `html_file_suffix` kis mértékben változott, üres string most" nincs utótag "helyett a" default utótag ", használata` `None`` az" alapértelmezett utótag ".
- New építők:
- Added építő EPUB formátum.
- Added építő kézikönyv-oldalak.
- Added egyetlen fájl HTML építője.
- HTML kimenet:
- Inline szerepeket most kap egy CSS osztályt a nevüket, így stílusok szabni a megjelenését. Domain-specifikus szerepeket kap két osztály, `` `` domain`` és terület-rolename``.
- Irodalom most kap az osztály `` internal`` ha ezek belső az egész projekt, szemben a belső az aktuális oldalra.
- A külső hivatkozások lehet más stílusú az új `` externalrefs`` téma opció az alapértelmezett téma.
- Az alapértelmezett téma, a tálaló lehet kísérletileg most tenni összecsukható az új `` collapsiblesidebar`` téma opció.
- Toctrees most csomagolva egy `` div`` tag osztályú `` toctree-wrapper`` HTML kimenetet.
- A: adatok: `toctree` lehívhatók sablonok most van egy` `maxdepth`` kulcsszó az érv, hogy ellenőrizzék a mélység a generált fa.
- A: adatok: `toctree` lehívhatók sablonok most elfogadja a` `titles_only`` kulcsszó érv.
- Added `` htmltitle`` blokk sablont.
- A JavaScript kereső, teszi lehetővé a keresést a tárgy nevét, beleértve a modul neve, mint a `` sys.argv``.
- Added új témát `` haiku`` által inspirált Haiku OS kézikönyvet.
- Added új témát `` nature``.
- Added új témát `` agogo`` által létrehozott Andi Albrecht.
- Added új témát `` scrolls`` által létrehozott Armin Ronacher.
- Hozzáadás a `` visitedlinkcolor`` téma opció az alapértelmezett témát.
- Továbbfejlesztett válaszkészség a keresési oldal betöltésével thesearch index aszinkron.
- Extension API:
- Added: esemény: `html-collect-pages`.
- Added: confval: `needs_sphinx` config érték és: met:` ~ sphinx.application.Sphinx.require_sphinx` alkalmazás API módszerrel.
- Added: met: `~ sphinx.application.Sphinx.add_stylesheet` alkalmazás API módszerrel.
- Extensions:
- Hozzáadás a mod: `~ sphinx.ext.viewcode` kiterjesztése.
- Hozzáadás a mod: `~ sphinx.ext.extlinks` kiterjesztése.
- A támogatás a forrása rendelési tagjainak autodoc, a `` autodoc_member_order = 'bysource'``.
- Added: confval: `autodoc_default_flags` config érték, amelyet fel lehet használni, hogy kiválassza az alapértelmezett zászlók minden autodoc irányelvek.
- Hozzáadás a módját intersphinx utalni elemzi címkéket más projektekben, és adja meg a kívánt projektet link.
- Autodoc most dokumentálja például attribútumok a `` __init__`` módszereket.
- Sok és javításokat a: mod: `~ sphinx.ext.autosummary` kiterjesztése, hála Pauli Virtanen.
- A: mod: `~ sphinx.ext.graphviz` hosszabbítás most kimeneti SVG helyett PNG képek, ellenőrzi a confval:` graphviz_output_format` config értéke.
- Added `` alt`` opciót: RST: dir: `graphviz` kiterjesztése irányelvek.
- Added `` exclude`` érv: FUNC: `.autodoc.between`.
- Fordítás:
- Added horvát fordítás, köszönhetően Bojan Mihelac.
- Török fordítás hozzáadva, köszönhetően Firat Ozgul.
- Hozzáadott katalán fordítás, köszönhetően a Pau Fernandez.
- Added egyszerűsített kínai fordítása.
- Added dán fordítás, köszönhetően Hjorth Larsen.
- Added litván fordítás, köszönhetően Dalius Dobravolskas.
Mi az új verzióban 1.0b1:
- Támogatás domainek került. A domain gyűjteménye irányelvek és szerepek, hogy minden leírni tárgyak tartoznak össze, pl eleme egy programozási nyelv. Néhány builtin tartományok vannak: - Python - C - C ++ - JavaScript - reStructuredText
- A régi jelölő meghatározása és összekapcsolása a C irányelvek nem fognak működni aktiválása nélkül `` oldcmarkup`` kiterjesztése.
- Az eltávolított támogatása a régi függőségi változat.
- Az eltávolított elavult elemek.
Mi az új verzióban 0.6.5:
- A autodoc, rögzítse a mulasztás néhány modul tagjai kifejezetten dokumentálni dokumentációt hozzászólás.
- Fix vágása sidebar görgetősáv a `` stickysidebar`` lehetőség az alapértelmezett téma.
- Mindig generálnak UNIX üres sorokat a gyorsindító Makefile.
- Fix fut `` -C`` Windows alatt.
- A autodoc, hogy testre az aláírás egy tárgy, ahol a beépített mechanizmus nem működik.
- Fix kimenet felsorolások a kezdeti értékeknek LaTeX.
- A `` start-after`` és `` end-before`` opciók a `` literalinclude`` irányelv működik megfelelően, ha nem használják együtt.
- Fix linket generáció a LaTeX építője.
Mi az új verzióban 0.6.4:
- Továbbfejlesztett kezelése nem Unicode karakterláncok a konfigurációs.
- Catch OSErrors előforduló hívás esetén Graphviz érvekkel nem érti.
- Restore kompatibilitás Pygments & gt; = 1,2.
- Fix menekülés a hyperref célokat LaTeX kimenettel.
- Fix kapcsolatok által generált ``: doc: `` szerepe LaTeX kimenettel.
- Gyűjtsük todo csomópontok után az egész dokumentumot olvasni; ez lehetővé teszi forgalomba cserét hivatkozások todo tételeket.
- Ne hagyja figyelmen kívül a kifejezett `` today`` config értéket a LaTeX épít.
- A `` alt`` szövege öröklési diagramok most már sokkal tisztább.
- Ignore képek szakaszban címek generálása során linket feliratokat.
- Támogatás kivétel üzeneteket a `` testoutput`` blokkok a `` doctest`` kiterjesztése.
- Vonal blokkok stílusú megfelelően HTML kimenetet.
- Készült a `` locale_dirs`` config értékű munkát újra.
- `` html_context`` megadott értékek a parancssorban a `` -A`` nem bírálhatja felül egyéb megadott értékeket conf.py.
- Fix egy szoftverhiba miatt inkrementális újraépítés a `` dirhtml`` építője.
- Fix a szétszedése idézetek néhány szó blokkok.
- Fix útvonal a keresési index a `` dirhtml`` építője.
- Fix Jython kompatibilitási probléma: hogy a függés a `` parser`` modul opcionális.
- A autodoc, az összes fogást előforduló hibák a modul import, nem csak `` ImportError``.
- Fix kezelését nem adatokat, de nem a módszer leírásokat autodoc.
- Ha másolás fájl alkalommal, figyelmen kívül hagyja OSErrors által felvetett `` os.utime () ``.
követelmények :
- Pygments 1.2 vagy újabb
- Jinja 2.3 vagy újabb
- Docutils 0/7 vagy nagyobb
Hozzászólás nem található