Sphinx

Kapag nilikha para sa unang pagkakataon, ito ay ang pangunahing layunin ay upang maglingkod bilang isang babasahin generator para sa sawa ng sariling code.
Mula noon, ang proyekto ay umabot sa katayuan ng kulto sa pag-unlad ng mundo, na isa sa mga pinaka-refer na impluwensya sa karamihan automatic babasahin generators paligid, anuman ang wika.
Ngayon, maliban lamang Python, Sphinx ay maaari ding gamitin sa C at C ++ code rin.

Ano ang bago sa release na ito:

• Magdagdag convenience direktiba at mga tungkulin sa C ++ domain: direktiba `` CPP: var`` bilang alias para `` CPP: member``, role ``: CPP: var`` bilang alias para sa ``: CPP: miyembro ``, at role `any` para sa cross-reference sa anumang C ++ declaraction.
• Ang: confval: `source_suffix` halaga config ay maaari na ngayong ng isang listahan ng maramihang mga suffix
.
• Magdagdag ng kakayahan upang tukuyin ang pinagmulan parsers pamamagitan ng source suffix sa: confval.: `Source_parsers` halaga config
• Ang isang bagong builder, AppleHelpBuilder, ay naidagdag na gagawa Apple Help Books.

Ano ang bago sa bersyon 1.2.3 / 1.3b3:

• Added `` sphinx.version_info`` tuple para programmatic checking ng mga bersyon Sphinx.

Ano ang bago sa bersyon 1.1.3:

• Mga Fixed crash sa ilang mga setting ng: confval.: `Modindex_common_prefix`
• Mga Fixed paghawak ng `` -D`` at `` -A`` opsyon sa Python 3.
• Kinikilala at balaan tungkol circular toctrees, sa halip ng sa pagtakbo sa mga error recursion.
• Ibalik sa pagiging tugma sa docutils trunk.
• Mga Fixed links index entry HtmlHelp muli.
• Mga Fixed inheritance_diagram pagtataas error attribute sa builtins.
• Mga Fixed-crash kapag paglagay ng mga komento o iisa tuntunin sa glossary.
• Mga Fixed HTML tulong mapping wika / encoding para sa lahat ng Sphinx suportadong wika.

Ano ang bago sa bersyon 1.1:

• Mga Tampok idinagdag:
• Idinagdag Python pag 3.x.
• New manggagawa at subsystem.
• Ang hindi katugmang mga pagbabago:
• Ang: rst: dir: `py: module` direktiba ay hindi output nito` `platform`` value opsyon anymore. (Ito ay ang tanging bagay na ang mga direktiba ay output, at sa gayon ay lubos na hindi naaayon.)
• Inalis ang suporta para sa mga lumang bersyon dependency.
• Bagong locale:
• Added Swedish locale.
• Added Iranian locale.
• Added Latvian locale.
• Added Nepali locale.
• Added Korean locale.
• Added Estonian locale.

Ano ang bago sa bersyon 1.0.8:

• Ayusin tracebacks para AttributeErrors in autosummary generation.
• Ayusin ang mga `` abbr`` papel kapag ang pagpapaikli may newlines sa loob nito.
• Ayusin ang mga link sa mga resulta sa mga uri ng mga pasadyang object paghahanap.
• Mga numero Fix line iniulat sa mga babala tungkol sa mga hindi tiyak na mga sanggunian.
• Ayusin ang C ++ kahulugan array at argumento template na hindi nagta-type ng mga pangalan.
• Payagan ang mga footnote sa header ng seksyon sa LaTeX output.
• Payagan ang mga keyword upang ma-link sa pamamagitan ng intersphinx.
• Payagan ang Unicode character sa mga pangalan ng token list production.
• Magdagdag dummy bisita para graphviz nodes para sa teksto at tao.
• Ayusin ang file pagkopya image bug.
• Ayusin ang pag-parse ng maramihang mga lagda sa C ++ domain.
• Huwag pansinin ang Emacs file lock kapag naghahanap para sa mga source file.
• Payagan .pyw extension para angkatin modules sa autodoc.
• I `` $ (GUMAGAWA) `` sa quickstart-generated Makefiles.
• Gumawa ng pare-pareho ang sidebar width kahon ng paghahanap sa browser.
• Ayusin ang spacing ng nakasentro numero sa HTML output.
• ligtas-encode SphinxError mensahe kapag print ang mga ito sa sys.stderr.
• Ayusin LaTeX error na output na may isang dokumento na walang seksyon ngunit isang target na link.
• tama ituturing ng built-in na paraan descriptors bilang paraan sa autodoc.
• Itigil monkeypatching ang textwrap module Python.
• Viewcode ay gumagana ng wasto na ngayon sa source file na non-ASCII encoding.
• Igalang ang `` option noindex`` bandila sa py. Module direktiba
• Ayusin IndexErrors kapag kasama nonexisting linya na may: rst: dir.: `Literalinclude`

String
• Paggalang pasadyang function / paraan separator parameter.
• Ayusin JS kalabanan sa jQuery & gt;. = 1.5
• Ayusin double encoding kapag tapos na ang pagsusulat HTMLHelp .hhk file.
• Huwag mag-aplay SmartyPants in parse-literal bloke.
• Sinusuportahan na ngayon ng C ++ domain kahulugan array.

Ano ang bago sa bersyon 1.0.6:

• Ayusin traceback sa sawa ng domain para sa mga walang laman na target ng cross-reference.
• Ayusin literal isyu block display sa browser ng Chrome.
• Support paghihiwalay ng limitadong hanay ng accented character sa pangkalahatang index at ang glossary.
• Subukan ang pagkabasa `` -D`` at `` -A`` command-line argumento na may ginustong encoding locale ni.
• Pagmasdan: confval.: `Locale_dirs` kapag naghahanap para sa JS pagsasalin file
• Magdagdag ng mga espesyal na code para sa mas mahusay na suporta ng mga Hapon dokumento sa LaTeX builder.
• Pagbabalik ng # 77: Kung may isa lamang na parameter na ibinigay sa ``: param.: `` Markup, ang listahan ng bullet ay pinigilan ngayon muli
• Ayusin ang mga nawawalang breaks talata sa LaTeX output sa ilang mga sitwasyon.
• humalimuyak ang `` autodoc-proseso-docstring`` event kahit na para sa mga bagay na walang docstring upang maaari itong magdagdag ng nilalaman.
• Sa LaTeX builder, hindi lamang literal na mga bloke ay nangangailangan ng ibang handling table, ngunit lubos ng ilang iba pang mga bloke ng mga sangkap listahan-like din.
• Ayusin tracebacks sa extension viewcode para sa mga sawa na mga bagay na hindi magkaroon ng isang may-bisang pirma.
• Ayusin ang kakaibang reportings ng mga numero ng linya para sa mga babala na nabuo mula autodoc-kasama docstrings, dahil sa iba't-ibang mga pag-uugali depende sa version docutils.
• Maraming mga pag-aayos sa C ++ domain.

Ano ang bago sa bersyon 1.0.5:

• Magdagdag CSS estilo hinihingi ng docutils 0.7 para nakahanay imahe at mga numero.
• Sa Makefile nabuo sa pamamagitan ng LaTeX output, huwag tanggalin pdf file sa malinis; sila ay maaaring maging kinakailangan imahe.
• nabuo para blocks line Fix LaTeX output.
• Payagan `` .pyw`` bilang extension ng source file.

Ano ang bago sa bersyon 1.0.4:

• Buksan intersphinx inventories sa binary mode sa Windows, dahil ito ay naglalaman version 2 data zlib-compress.
• Payagan ang pagbibigay di-lokal na URI para sa mga file ng JavaScript, eg sa JSMath extension.
• Ayusin traceback kapag `` intersphinx_mapping`` ay walang laman.

Ano ang bago sa bersyon 1.0.3:

• Ayusin ang internal kumpara panlabas na pagkakaiba link para sa mga link na nagmula sa isang docutils table-of-nilalaman.
• Ayusin ang mga `` maxdepth`` opsyon para sa `` toctree () `` template callable kapag ginamit sa `` pagbagsak = True``.
• Ayusin crash sa pag-parse ng mga listahan Python argument na naglalaman ng bracket sa string literals.
• Ayusin ang pagbabalik kapag gusali LaTeX docs na may mga numero na walang mga caption.
• Ayusin ang inheritance diagram para sa mga klase na hindi picklable.
• Ipakilala hiwalay na kulay ng background para sa mga pindutan na pagbagsak sidebar, na ginagawang mas madaling makita.
• Ayusin ang mga maliliit na layout bugs sa ilang mga built-in na mga tema.

Ano ang bago sa bersyon 1.0.2:

• Ayusin ang mga cross-reference sa mga bagay ng uri idinagdag sa pamamagitan ng: func.: `~ .Sphinx.add_object_type` API function
• Ayusin ang paghawak ng mga uri ng patlang doc para sa iba't ibang mga uri direktiba.
• Payagan ang paglabag mahabang lagda, patuloy na may backlash-escaped newlines.
• Ayusin ang mga hindi ginustong mga styling ng C sanggunian domain (dahil sa isang namespace paglalaban sa Pygments estilo).
• Payagan ang mga sanggunian sa peps at RFCs sa tahasang anchor.
• Ayusin LaTeX mga sanggunian sa mga numero.
• Kapag gumagawa ng isang di-eksaktong paghahanap, tugma lamang ang naibigay na uri ng object.
• Gamitin ang non-eksaktong paghahanap para sa mga sawa na target reference na may `` .name`` para sa modules masyadong.
• Ayusin crash kapag pagkokopya ng isang parameter sa isang listahan ng field info.
• Ayusin ang mga setting ng default na papel sa isa ibinigay ng `` oldcmarkup`` extension.
• Ayusin crash kapag json-py ay naka-install, na kung saan ay nagbibigay ng isang `` json`` module ngunit ay hindi tugma sa simplejson.
• Ayusin ang paghawak ng mga target sa pagbibigay ng pangalan sa intersphinx.
• Ayusin ang pag-alis ng ``! `` Para sa lahat ng mga tungkulin ng cross-reference.

Ano ang bago sa bersyon 1.0.1:

• Ayusin nakabuo target na pangalan para sa natitirang bahagi ng mga bagay domain; ang mga ito ay hindi sa parehong namespace.
• Magdagdag ng wika Bengali.
• Ayusin ang isang bug sa pag-parse ng mga pangalan ng object JavaScript.
• Ayusin ang gusali na may SingleHTMLBuilder kapag walang toctree.
• Ayusin ang display ng mga pangalan para sa mga bagay na naka-link sa pamamagitan ng intersphinx na may malinaw na mga target.
• Ayusin ang gusali sa JSON builder.
• Ayusin hyperrefs sa object paglalarawan para sa LaTeX.

Ano ang bago sa bersyon 1.0:

• General:
• Naidagdag isang "nitpicky" mode na emits babala para sa lahat ng mga nawawalang mga sanggunian. Ito ay aktibo sa pamamagitan ng: Ang opsyon: `-n` command-line lumipat o ang: confval.:` Halaga config nitpicky`
• Added `` latexpdf`` target sa quickstart Makefile.
• Markup:
• Ang: rst: role: `menuselection` at: rst: role.:` Guilabel` ginagampanan ngayon ng suporta ampersand accelerators
• Bago pa compact field doc syntax ngayon ay kinikilala: ``: pangalan ng uri param:. Description``
• Added `` tab-width`` option to: rst: dir.: `Literalinclude` direktiba
• Added `` option titlesonly`` sa: rst: dir.: `Toctree` direktiba
• Idinagdag ang `` prepend`` at `` append`` opsyon sa: rst: dir.: `Literalinclude` direktiba
• Lahat docinfo metadata ngayon ay ilagay sa ang metadata ng dokumento, hindi lamang ang mga may-akda.
• Ang: rst: role: `maaari ngayon din sa reference ref` role mesa sa pamamagitan ng caption
.
• Ang: rst: dir.: `Include` direktiba Sinusuportahan na ngayon ng absolute path, na kung saan ay naisalin na bilang kamag-anak sa source direktoryo
• Sa Python domain, sanggunian tulad ng ``: func.: `.name``` Ngayon tumingin para sa pagtutugma ng mga pangalan ng anumang prefix kung walang direktang tugma ay natagpuan
• Configuration:
• Added: confval.: `Rst_prolog` halaga config
• Added: confval.: `Html_secnumber_suffix` config halaga upang makontrol section numbering format
• Added: confval.: `Html_compact_lists` config halaga upang makontrol ang tampok na compact lists docutils '
• Ang: confval: `halaga config html_sidebars` maaring maglaman ng mga pattern tulad ng mga pindutan, at ang mga halaga ay maaaring maging mga listahan na malinaw na piliin kung aling mga template sidebar dapat na nai-render. Iyon ay nangangahulugan na ang builtin nilalaman sidebar maaaring kasama lamang selectively.
• : confval.: `Maaari html_static_path` ngayon naglalaman single entries file
• Ang mga bagong universal value config: confval: `exclude_patterns` gumagawa ng mga old: confval:` unused_docs`,: confval: `exclude_trees` at: confval.:` Exclude_dirnames` laos
• Added: confval.: `Halaga config html_output_encoding`
• Added ang: confval: `latex_docclass` halaga config at ginawa ang" twoside "na opsyon documentclass overridable sa pamamagitan ng" oneside "
.
• Added ang: confval.: `Trim_doctest_flags` halaga config, na kung saan ay sa pamamagitan ng default true
• Added: confval.: `Halaga config html_show_copyright`
• Added: confval: `latex_show_pagerefs` at: confval.:` Latex_show_urls` values ​​config
• Ang pag-uugali ng: confval: `html_file_suffix` bahagyang nagbago: ang walang laman na string ngayon ay nangangahulugan ng" hindi suffix "sa halip ng" default suffix ", gamitin` `None`` para sa" default suffix "
.
• New tagapagtayo:
• Naidagdag isang builder para sa mga format Epub.
• Naidagdag isang builder para sa manual na pahina.
• Added isang single-file builder HTML.
• HTML output:

Ginagampanan
• Inline ngayon makakuha ng isang CSS klase sa kanilang mga pangalan, na nagpapahintulot sa mga estilo upang ipasadya ang kanilang hitsura. Tungkulin Domain-specific makakuha ng dalawang klase, `` domain`` at `` domain-rolename``.
• Mga sanggunian ngayon makakuha ng mga klase `` internal`` kung panloob na ang buong proyekto nila, bilang laban sa panloob na sa kasalukuyang pahina.
• Panlabas na mga sanggunian ay maaaring mapagpanggap naiiba na may bagong option `` externalrefs`` tema para sa default na tema.
• Sa default na tema, maaari pagtuklas ngayon ay ginawa collapsible sidebar gamit ang bagong `option` collapsiblesidebar`` tema.
• Toctrees ay abala ngayon sa isang `` div`` tag na may klase `` toctree-wrapper`` sa HTML output.
• Ang: data.: `Toctree` callable sa mga template na ngayon ay isang` `maxdepth`` argument keyword upang kontrolin ang lalim ng nakabuo ng puno
• Ang: data.: `Toctree` callable sa mga template ay tumatanggap na ngayon ng isang` `titles_only`` argument keyword
• Added `` htmltitle`` block sa template ng layout.
• Sa paghahanap JavaScript, payagan na naghahanap para sa mga pangalan ng object kabilang ang pangalan ng module, tulad ng `` sys.argv``.
• Nagdagdag ng bagong tema `` haiku``, inspirasyon sa pamamagitan ng mga gabay sa paggamit ng Haiku OS.
• Nagdagdag ng bagong tema `` nature``.
• Nagdagdag ng bagong tema `` agogo``, nilikha sa pamamagitan Andi Albrecht.
• Nagdagdag ng bagong tema `` scrolls``, nilikha sa pamamagitan Armin Ronacher.
• Nagdagdag ng option `` visitedlinkcolor`` tema sa default na tema.
• Pinahusay na pagtugon ng pahina ng paghahanap sa pamamagitan ng pagkarga thesearch index asynchronously.
• Extension API:
• Added: event.: `Html-mangolekta-pages`
• Added: confval: `needs_sphinx` halaga config at: meth.:` ~ Method sphinx.application.Sphinx.require_sphinx` application API
• Added: meth.: `~ Method sphinx.application.Sphinx.add_stylesheet` application API
• Mga Extension:
• Added ang: mod: `~ extension sphinx.ext.viewcode`
.
• Added ang: mod: `~ extension sphinx.ext.extlinks`
.
• Added suporta para sa source ng pag-order ng mga kasapi sa autodoc, na may `` autodoc_member_order = 'bysource'``.
• Added: confval.: `Autodoc_default_flags` halaga config, na maaaring magamit upang piliin ang default flags para sa lahat autodoc direktiba
• Naidagdag isang paraan para intersphinx upang sumangguni sa pangalang label sa iba pang mga proyekto, at upang tukuyin ang mga proyekto na nais mong i-link.
• autodoc maaari na ngayong mga dokumento ng halimbawa katangian na nakatalaga sa `` __init__`` methods.
• Maraming mga pagpapabuti at pag-aayos sa: mod.: `~ Sphinx.ext.autosummary` extension, salamat sa Pauli Virtanen
• Ang: mod: `~ extension sphinx.ext.graphviz` maaari output ngayon SVG halip ng PNG na imahe, kontrolado ng confval.:` Graphviz_output_format` halaga config
• Added `` option alt`` sa: rst: dir.: `Graphviz` direktiba extension
• Added `` exclude`` argument sa: func.: `.autodoc.between`
• Translations:
• Added translation Croatian, salamat sa Bojan Mihelac.
• Added translation Turkish, salamat sa Firat Ozgul.
• translation Idinagdag Catalan, salamat sa Pau Fernandez.
• Added translation pinasimpleng Chinese.
• Added translation Danish, salamat sa Hjorth Larsen.
• Added translation Lithuanian, salamat sa Dalius Dobravolskas.

Ano ang bago sa bersyon 1.0b1:

• Suporta para sa mga domain ay naidagdag na. Ang isang domain ay isang koleksyon ng mga direktiba at mga tungkulin na ang lahat naglalarawan ng mga bagay na pagmamay-ari ng sama-sama, eg mga elemento ng isang programming language. Ang ilang builtin domain ay ibinigay: - Python - C - C ++ - JavaScript - reStructuredText
• Ang lumang markup para sa pagtukoy at pag-link sa C direktiba hindi gagana anymore walang gawing aktibo ang mga `` oldcmarkup`` extension.
• Inalis ang suporta para sa mga lumang bersyon dependency.
• Inalis pinapagamit elemento.

Ano ang bago sa bersyon 0.6.5:

• Sa autodoc, ayusin ang mga pagkukulang ng ilang mga kasapi module malinaw na dokumentado gamit babasahin komento.
• Ayusin ang pagtatabas ng sidebar scroll bar na may `` stickysidebar`` opsyon ng ang default na tema.
• Palaging bumuo UNIX newlines sa quickstart Makefile.
• Ayusin ang tumatakbo sa `` -C`` ilalim ng Windows.
• Sa autodoc, payagan ang pagpapasadya ng pirma ng isang bagay kung saan nabigo ang built-in na mekanismo.
• Ayusin ang output para sa inisa-isa na listahan sa mga halaga na simula sa LaTeX.
• Gawin ang `` start-after`` at `` opsyon end-before`` sa `` literalinclude`` direktiba trabaho nang tama kung hindi ginagamit magkasama.
• Ayusin ang link henerasyon sa LaTeX builder.

Ano ang bago sa bersyon 0.6.4:

• Pinahusay na ang paghawak ng mga hindi-Unicode string sa configuration.
• mahuli OSErrors nagaganap kapag tumatawag graphviz gamit ang mga argumentong ito ay hindi maunawaan.
• Ibalik sa pagiging tugma sa Pygments & gt;. = 1.2
• Ayusin ang pagtakas ng hyperref target sa LaTeX output.
• Ayusin ang mga link na nabuo sa pamamagitan ng ``: doc.: `` Papel para LaTeX output
• Mangolekta todo nodes matapos ang buong dokumento ay basahin; ito ay nagpapahintulot sa paglalagay ng pagpapalit sanggunian sa todo item.
• Huwag pansinin ang isang tahasang `` today`` halaga config sa isang LaTeX build.
• Ang `` alt`` text ng mana diagram ngayon ay marami cleaner.
• Huwag pansinin ang mga imahe sa mga pamagat ng seksyon kapag ang pagbuo ng mga caption na link.
• exception Support mensahe sa `` testoutput`` bloke ng `` extension doctest``.
• blocks Line ay nagbabansag ng maayos sa HTML output.
• Ginawa muli ang `` locale_dirs`` halaga config trabaho.
• `` values ​​html_context`` ibinigay sa command line sa pamamagitan ng `` hindi -A`` dapat pawalang-bisa ibang mga halaga na ibinigay sa conf.py.
• Ayusin ang isang bug na pumipigil sa incremental rebuilds para sa `` dirhtml`` builder.
• Ayusin ang mangling ng mga quote sa ilang mga literal na mga bloke.
• Ayusin ang path sa index ng paghahanap para sa `` dirhtml`` builder.
• Ayusin ang isang isyu sa pagiging tugma Jython: gawin ang pagtitiwala sa mga `` parser`` module opsyonal
.
• Sa autodoc, mahuli ang lahat ng mga error na nangyari sa module import, hindi lamang `` ImportError``.
• Ayusin ang paghawak ng mga di-data, ngunit di-method descriptors in autodoc.
• Kapag ang pagkopya ng file ulit, huwag pansinin OSErrors inihahain ng `` os.utime () ``.

Kinakailangan :

• Pygments 1.2 o mas mataas na
• Jinja 2.3 o mas mataas na
• Docutils 0/7 o mas mataas