Sphinx

Při vytvořený pro první čas, to je hlavním účelem bylo sloužit jako generátor dokumentace pro Python 's vlastním kódem.
Od té doby, projekt dosáhl kultovní status v rozvojovém světě, je jedním z nejvíce citovaných vlivů ve většině automatických generátorů dokumentace kolem, bez ohledu na jazyk.
V současné době, kromě jen Python, Sphinx může být také použit s C a C ++ kódu, stejně.

Co je nového v této verzi:

• Přidat direktivy pohodlí a role, C ++ doméně: Směrnice `` CPP: var`` jako alias pro `` CPP: member``, úloha ``: cpp: var`` jako alias pro ``: CPP: člen ``, a role `any` za odkazem na jakoukoli C ++ declaraction.
• : confval: `source_suffix` config hodnota může být nyní seznam více přípon
.
• Přidat schopnost určit zdrojové analyzátory podle zdroje příponou se: confval:. `Source_parsers` config hodnoty
• Nový stavitel, AppleHelpBuilder, byl dodal, že staví Apple help knihy.

Co je nového ve verzi 1.2.3 / 1.3b3:

• přidáno `` sphinx.version_info`` tice pro programovou kontrolu verze Sphinx.

Co je nového ve verzi 1.1.3:

• Opraven pád s některými nastavením: confval:. `Modindex_common_prefix`
• Opraveno zpracování `` -D`` a `` -A`` možnosti na Pythonu 3.
• Uznávaný a varovat před kruhových toctrees, namísto spuštění do chyb rekurze.
• Obnovit kompatibilitu s docutils kufru.
• HTMLHelp Pevné vstup index odkazy znovu.
• Pevná inheritance_diagram zvýšení chyby atributů na vestavěných příkazů.
• Opraveno dojde k chybě při uvedení komentáře nebo osamělé termíny v glosáři.
• Pevná HTML help jazyk / kódování mapování pro všechny sfingy podporovaných jazycích.

Co je nového ve verzi 1.1:

• Vlastnosti dodal:
• Přidána podpora Python 3.x.
• Nové stavitelé a subsystém.
• Nekompatibilní změny:
• : RST: dir: `py: module` směrnicí není výstup jeho` `platform`` možnost hodnota ještě. (To byla jediná věc, která směrnice udělal výstup, a tudíž zcela nekonzistentní.)
• Odstraněna podpora pro staré verze závislostí.
• Nové locales:
• Přidán Švédský locale.
• Přidána íránský locale.
• Přidána Lotyšský locale.
• Přidána Nepali locale.
• Přidána korejské národní prostředí.
• Přidána Estonian locale.

Co je nového ve verzi 1.0.8:

• Fix tracebacks pro AttributeErrors v autosummary generace.
• Připevněte `` abbr`` roli při zkratka má nové řádky v něm.
• Fix odkazy na výsledky hledání s vlastní typy objektů.
• čísla Fix řádku hlášené v varování o nedefinovaných referencí.
• definice Fix C ++ pole a šablony argumenty, které nejsou typově jména.
• Povolit poznámky pod čarou v sekci záhlaví v LaTeXu výstupu.
• Povolit klíčová slova, které mají být propojeny přes intersphinx.
• Povolit znaky Unicode v seznamu výrobních názvů tokenu.
• Přidat falešné návštěvníky graphviz uzly pro text a člověkem.
• Fix image file duplikace chyba.
• Oprava parsování více podpisů v C ++ doméně.
• Ignorovat Emacs zámků souborů, když hledáte zdrojové soubory.
• Povolit .pyw rozšíření pro dováženého moduly v Autoošetřovny.
• Používání `` $ (make) `` v QuickStart generované Makefile.
• Zkontrolujte, sidebar šířka vyhledávací pole konzistentní v prohlížečích.
• Fix Odstup soustředěných postav v HTML výstupu.
• Bezpečně zakódovat SphinxError zprávy, když jejich tisk na sys.stderr.
• chybový výstup Fix LaTeX s dokumentem bez úseky, ale cíl odkazu.
• správně zacházet zabudovanou metodu popisovačů jako metod v Autoošetřovny.
• Zastavit monkeypatching na textwrap modul Pythonu.
• Viewcode nyní pracuje správně se zdrojovými soubory, které mají kódování non-ASCII.
• Respektovat `` noindex`` možnost vlajka ve py:. Směrnic modulu
• Fix IndexErrors při včetně neexistující linky s: RST: dir:. `Literalinclude`
• Respect vlastní funkce / separátor metoda parametr řetězce.
• Fix JS neslučitelnost s jQuery & gt;. = 1,5
• Fix dvojí kódování udělat při psaní HTMLHelp .hhk soubory.
• Nepoužívejte SmartyPants v analyzovaných-doslovných bloků.
• C ++ doména nyní podporuje definice pole.

Co je nového ve verzi 1.0.6:

• Fix traceback v Pythonu doméně prázdných cross-referenčních cílů.
• Fix doslovné problémy zobrazení blok na prohlížečů Chrome.
• Podpora třídění omezený rozsah znaků s diakritikou v souhrnném indexu a slovníku.
• Zkuste dekódování `` -D`` a `` -A`` argumenty příkazového řádku s přednostním kódováním locale je.
• Dodržujte: confval:. `Locale_dirs` při hledání překladů souboru JS
• Přidat speciální kód pro lepší podporu japonských dokumentů v LaTeXu stavitele.
• regrese # 77: Pokud existuje pouze jeden parametr uveden s ``: param:. `` Značkovací, seznam kulka je nyní opět potlačena
• Fix chybí odstavců přestávky v LaTeXu výstup v určitých situacích.
• se zapíší na `` Autoošetřovny-proces-docstring`` událost i pro objekty bez dokumentačního řetězce tak, že může přidat obsah.
• V LaTeXu stavitel, nejen doslovné bloky vyžadují různé manipulace tabulky, ale také docela několik dalších prvků list-jako blok.
• Fix tracebacks v prodloužení viewcode pro Python objekty, které nemají platný podpis.
• Fix podivné reportings čísel řádku pro varování generované z Autoošetřovny-zahrnuty docstrings, kvůli odlišné chování v závislosti na docutils verzi.
• Několik oprav na ++ doméně C.

Co je nového ve verzi 1.0.5:

• Přidat CSS styly požadované docutils 0,7 pro seřazených snímků a údajů.
• V Makefile generovány LaTeX výstupem, neodstraňujte PDF soubory na čisté; by mohly být zapotřebí obrázky.
• Fix LaTeX výstup generovaný pro řádkové bloky.
• Povolit `` .pyw`` jako rozšíření zdrojového souboru.

Co je nového ve verzi 1.0.4:

• Otevřít intersphinx zásob v binárním režimu v systému Windows, od verze 2 obsahuje zlib-komprimovaných dat.
• Povolit dávat non-lokální URI pro soubory JavaScript, např v prodloužení JSMath.
• Fix traceback když `` intersphinx_mapping`` je prázdný.

Co je nového ve verzi 1.0.3:

• Fix interní vs. externí odkaz rozdílu na odkazy pocházející z docutils table-of-obsah.
• Připevněte `` maxdepth`` možnost pro `` toctree () `` šablona splatné při použití s ​​`` kolaps = True``.
• Fix crash analýzy Python seznamy argumentů, které obsahují závorky v řetězci literály.
• Fix regrese při stavbě LaTeX docs s postavami, které nemají titulky.
• Fix dědické diagramy tříd, které nejsou picklable.
• Zavést oddělený barvu pozadí pro tlačítko sidebar zhroucení, takže je lépe vidět.
• Fix malé rozvržení chyby v několika vestavěné v tématech.

Co je nového ve verzi 1.0.2:

• Fix křížové odkazy na objekty typů přidané podle: FUNC:. `~ Funkce .Sphinx.add_object_type` API
• manipulace Fix typů doc polí pro různé typy směrnice.
• Povolit prolomení dlouhé podpisy, pokračovat vůle-utekl nové řádky.
• Fix nežádoucí styl referencí domény C (z důvodu jmenného prostoru střetu s Pygments styly).
• Povolit odkazy na PEO a RFC s explicitními kotev.
• Fix LaTeX odkazy na obrázky.
• Při non-přesné vyhledávání, zápas pouze daný typ objektu.
• Použít non-přesné vyhledávání referenční cíle Python s `` .name`` pro moduly taky.
• Fix pád při duplikaci parametr v seznamu info pole.
• Fix nastavení výchozí roli jednoho poskytnuté `` oldcmarkup`` rozšíření.
• Fix pád když je instalována JSON-py, který poskytuje `` json`` modul, ale je nekompatibilní se simplejson.
• manipulace Fix cílového pojmenování v intersphinx.
• odstranění Fix z ``! `` Pro všechny cross-referenční rolí.

Co je nového ve verzi 1.0.1:

• Fix vygenerované cílové názvy pro objekty domény odpočinku; nejsou ve stejném jmenném prostoru.
• Přidat Bengálština.
• Opravuje chybu v analýze názvy objektů JavaScript.
• Fix budova s ​​SingleHTMLBuilder kdy není toctree.
• zobrazení Fix názvy pro objekty spojené s tím, intersphinx s explicitními cíli.
• Fix budova s ​​JSON stavitelem.
• Fix hyperrefs v popisech objektů pro LaTeX.

Co je nového ve verzi 1.0:

• Obecné:
• Přidána režim "nitpicky", který vydává varování pro všechny chybějící reference. To je aktivován: Možnost: `-n` přepínač příkazového řádku, nebo: confval:.` Nitpicky` config hodnoty
• přidáno `` latexpdf`` cíl v QuickStart Makefile.
• Markup:
• : RST: Role: `menuselection` a: RST: role:.` Guilabel` role nyní podporují ampersandem urychlovače
• Nová syntaxe více kompaktní doc pole je nyní rozpoznán: ``: název typu param:. Description``
• přidáno `` tab-width`` možnost: RST: dir:. `Literalinclude` směrnice
• Přidána `` možnost titlesonly`` na: RST: dir:. `Směrnice toctree`
• Přidána `` prepend`` a `` append`` voleb do: RST: dir:. `Literalinclude` směrnice
• Všechny docinfo metadata se nyní vloží do metadat dokumentu, ne jen autor.
• : RST: Role: `ref` role mohou nyní také odkazovat tabulky podle titulku
.
• : RST: dir:. `Include` směrnice nyní podporuje absolutní cesty, které jsou interpretovány jako relativní k zdrojového adresáře
• V oblasti Pythonu, odkazy, jako jsou ``: FUNC:. `.name``` Nyní hledat odpovídající jména s jakýmkoliv prefixem, pokud je nalezena žádná přímá shoda
• Konfigurace:
• Přidáno: confval:. `Rst_prolog` config hodnota
• Přidáno: confval:. `Hodnota html_secnumber_suffix` config řídit sekce formát číslování
• Přidáno: confval:. `Html_compact_lists` config hodnota ovládat docutils" kompaktní seznamy mají
• : confval: `html_sidebars` config hodnota může nyní obsahovat vzory jako klíče a hodnoty mohou být seznamy, které explicitně zvolit, které sidebar šablony by měl být vykreslen. To znamená, že zabudovaná obsah postranního panelu mohou být zahrnuty pouze výběrově.
• : confval:. `Html_static_path` mohou nyní obsahují jednotlivé položky souboru
• Nový univerzální hodnota config: confval: `exclude_patterns` dělá staré: confval:` unused_docs`,: confval: `exclude_trees` a: confval:.` Exclude_dirnames` zastaralé
• Přidáno: confval:. `Html_output_encoding` config hodnota
• Přidána: confval: `latex_docclass` config hodnotu a dělal" twoside "DocumentClass možnost overridable o" oneside "
.
• Přidána: confval:. `Trim_doctest_flags` konfigurační hodnotu, která je pravdivá ve výchozím nastavení
• Přidáno: confval:. `Html_show_copyright` config hodnota
• Přidáno: confval: `latex_show_pagerefs` a: confval:.` Latex_show_urls` hodnoty config
• chování: confval: `html_file_suffix` mírně změnil: prázdný řetězec nyní znamená" ne příponu "namísto" výchozí příponu ", použití` `None`` pro" výchozí příponu "
.
• Nové stavitelé:
• Přidána stavitel na formátu EPUB.
• Přidána stavitele pro manuálové stránky.
• Přidána single-souboru HTML Builder.
• HTML výstup:
• Inline role nyní získat třídu CSS se svým jménem, ​​což styly přizpůsobit jejich vzhled. Domény-specifické role dostat dvě třídy, `` `` domain`` a domény-rolename``.
• Reference nyní získat třídu `` internal``, pokud jsou interní pro celý projekt, na rozdíl od vnitřní na aktuální stránku.
• Externí odkazy lze různě stylizované s novým `` externalrefs`` téma volby pro výchozí motiv.
• Ve výchozí motiv, postranním panelu lze experimentálně nyní být skládací pomocí nového `` téma volby collapsiblesidebar``.
• Toctrees jsou nyní zabalené v `` div`` štítek s třídou `` toctree-wrapper`` v HTML výstupu.
• : Data:. `Toctree` splatné v šablonách má nyní` `maxdepth`` argument, klíčové slovo kontrolovat hloubku vygenerovaného stromu
• : Data:. `Toctree` splatné v šablonách nyní přijímá` `titles_only`` klíčových slov argument,
• přidáno `` htmltitle`` blok šablony rozvržení.
• V hledání JavaScript, umožňují hledat názvy objektů, včetně název modulu, stejně jako `` sys.argv``.
• Přidán nový motiv `` haiku``, inspirovaný uživatelské příručce Haiku OS.
• Přidán nový motiv `` nature``.
• Přidán nový motiv `` agogo``, vytvořený Andi Albrecht.
• Přidán nový motiv `` scrolls``, vytvořený Armin Ronacher.
• Přidána `` visitedlinkcolor`` motiv možnost na výchozí motiv.
• Lepší citlivost na vyhledávací stránku načtením thesearch indexu asynchronně.
• Extension API:
• Přidáno: událost:. `Html-collect-pages`
• Přidáno: confval: `needs_sphinx` config hodnota a: meth:.` ~ Metoda sphinx.application.Sphinx.require_sphinx` aplikace API
• Přidáno: meth:. `~ Metoda sphinx.application.Sphinx.add_stylesheet` aplikace API
• Rozšíření:
• Přidána: MOD: `~ rozšíření sphinx.ext.viewcode`
.
• Přidána: MOD: `~ rozšíření sphinx.ext.extlinks`
.
• Přidána podpora pro zdrojový uspořádání členů v Autoošetřovny, s `` autodoc_member_order = 'bysource'``.
• Přidáno: confval:. `Autodoc_default_flags` config hodnota, která může být použita pro výběr výchozího příznaky pro všechny směrnice Autoošetřovny
• Přidána způsob, jak pro intersphinx odvolat se na pojmenované štítků v jiných projektech, a upřesnit projekt, který chcete propojit.
• Autoošetřovny nyní mohou dokumentovat instanci atributy přiřazeny `` __init__`` metod.
• Mnoho vylepšení a opravy na: MOD:. `~ Prodloužení sphinx.ext.autosummary`, díky Pauli Virtanen
• : mod: `~ rozšíření sphinx.ext.graphviz` mohou nyní výstup SVG místo PNG obrázků, řízen confval:.` Graphviz_output_format` config hodnoty
• Přidána `` možnost alt`` na: RST: dir:. `Směrnic graphviz` prodloužení
• přidáno `` exclude`` argument: FUNC:. `.autodoc.between`
• Překlady:
• Přidáno chorvatský překlad, díky Bojan Mihelac.
• Přidaný turecké překlad, díky Firat Ozgul.
• Přidáno Katalánština překlad, díky Pau Fernandez.
• Přidána zjednodušená čínština překlad.
• Přidána dánština překladu, díky Hjorth Larsen.
• Přidaný litevský překlad, díky Dalius Dobravolskas.

Co je nového ve verzi 1.0b1:

• Podpora pro domény byl přidán. Doména je sbírka směrnic a rolí, které popisují všechny objekty, které patří dohromady, např prvky programovacího jazyka. Několik vestavěný domén jsou k dispozici: - Python - C - C ++ - JavaScript - reStructuredText
• Starý přirážka pro definování a propojení směrnic C nebude fungovat už bez aktivace `` oldcmarkup`` rozšíření.
• Odstraněna podpora pro staré verze závislostí.
• Odstraněny zastaralé prvky.

Co je nového ve verzi 0.6.5:

• V Autoošetřovny, opravit vynechání některých členů modulu výslovně zdokumentovaný pomocí dokumentační komentáře.
• Fix ořezávání z postranního panelu posuvníku s `` stickysidebar`` volby výchozího motivu.
• Vždy generovat UNIX nové řádky v QuickStart Makefile.
• Fix běží s `` -C`` pod Windows.
• V Autoošetřovny, umožnit přizpůsobení podpis objektu, kde se vestavěný mechanismus selže.
• Fix výstup pro vyjmenované seznamy s hodnotami startu v LaTeXu.
• Proveďte `` start-after`` a `` možnosti end-before`` na `` literalinclude`` směrnice správně fungovat, pokud nejsou používány společně.
• Fix odkaz generace v LaTeXu stavitel.

Co je nového ve verzi 0.6.4:

• Lepší nakládání s non-Unicode řetězců v konfiguraci.
• Catch OSErrors vyskytující se při volání graphviz s argumenty, že nerozumí.
• Obnovit kompatibilitu s Pygments & gt;. = 1,2
• Fix úletu hyperref cílů v LaTeXu výstupu.
• Fix odkazy generované ``: doc: ``. Role LaTeX výstup
• Collect todo uzlů po celý dokument byl četl; to umožňuje umístit substitučních odkazy v todo položek.
• Nepřehlížejte explicitní `` today`` config hodnoty v LaTeXu sestavení.
• `` alt`` text dědické diagramů je nyní mnohem čistší.
• Ignorovat snímků v sekci titulů při generování odkazů titulky.
• Podpora výjimky zprávy ve `` testoutput`` bloků `` rozšíření doctest``.
• bloky linky jsou správně stylizované v HTML výstupu.
• znovu Vyrobeno `` locale_dirs`` config hodnoty práce.
• `` html_context`` hodnoty uvedeny na příkazovém řádku přes `` -A`` neměli přednost jiné hodnoty uvedené v conf.py.
• Opravuje chybu brání přírůstkové rebuilds pro `` dirhtml`` stavitel.
• Fix mandlování citací v některých doslovných blocích.
• Fix cesta k hledání index pro `` dirhtml`` stavitel.
• Fix problém s kompatibilitou Jython: aby se závislost na `` parser`` modul volitelného
.
• V Autoošetřovny, zachytit všechny chyby, ke kterým dochází při importu modulu, a to nejen `` ImportError``.
• Fix manipulaci s non-data, ale non-metoda popisovače v Autoošetřovny.
• Při kopírování soubor časy, ignorujte OSErrors vznesené `` os.utime () ``.

Požadavky na :

• Pygments 1.2 nebo vyšší,
• Jinja 2.3 nebo vyšší
• Docutils 0/7 nebo vyšší