Release1.0.7(Jan15,2011)============================*#347: Fix wrong generation of directives of static methods inautosummary.*#599: Import PIL as ``from PIL import Image``.*#558: Fix longtables with captions in LaTeX output.*MaketokenreferencesworkashyperlinksagaininLaTeXoutput.*#572: Show warnings by default when reference labels cannot befound.*#536: Include line number when complaining about missing referencetargetsinnitpickymode.*#590: Fix inline display of graphviz diagrams in LaTeX output.*#589: Build using app.build() in setup command.*Fixabugintheinheritancediagramexceptionthatcausedbaseclassestobeskippedifoneofthemisabuiltin.*FixgeneralindexlinksforC++domainobjects.*#332: Make admonition boundaries in LaTeX output visible.*#573: Fix KeyErrors occurring on rebuild after removing a file.*Fixatracebackwhenremovingfileswithglobbedtoctrees.*Ifanautodocobjectcannotbeimported,alwaysre-readthedocumentcontainingthedirectiveonnextbuild.*Ifanautodocobjectcannotbeimported,showthefulltracebackoftheimporterror.*Fixabugwheretheremovalofdownloadfilesandimageswasn'tnoticed.*#571: Implement ``~`` cross-reference prefix for the C domain.*FixregressionofLaTeXoutputwiththefixof#556.*#568: Fix lookup of class attribute documentation on descriptorssothatcommentdocumentationnowworks.*Fixtracebackwith``only``directivesprecededbytargets.*FixtracebacksoccurringforduplicateC++domainobjects.*FixJavaScriptdomainlinkstoobjectswith``$``intheirname.Release1.0.6(Jan04,2011)============================*#581: Fix traceback in Python domain for empty cross-referencetargets.*#283: Fix literal block display issues on Chrome browsers.*#383, #148: Support sorting a limited range of accented charactersinthegeneralindexandtheglossary.*#570: Try decoding ``-D`` and ``-A`` command-line arguments withthelocale's preferred encoding.*#528: Observe :confval:`locale_dirs` when looking for the JStranslationsfile.*#574: Add special code for better support of Japanese documentsintheLaTeXbuilder.*Regressionof#77: If there is only one parameter given with``:param:``markup,thebulletlistisnowsuppressedagain.*#556: Fix missing paragraph breaks in LaTeX output in certainsituations.*#567: Emit the ``autodoc-process-docstring`` event even for objectswithoutadocstringsothatitcanaddcontent.*#565: In the LaTeX builder, not only literal blocks require differenttablehandling,butalsoquiteafewotherlist-likeblockelements.*#515: Fix tracebacks in the viewcode extension for Python objectsthatdonothaveavalidsignature.*Fixstrangereportingsoflinenumbersforwarningsgeneratedfromautodoc-includeddocstrings,duetodifferentbehaviordependingondocutilsversion.*SeveralfixestotheC++domain.Release1.0.5(Nov12,2010)============================*#557: Add CSS styles required by docutils 0.7 for aligned imagesandfigures.*IntheMakefilegeneratedbyLaTeXoutput,donotdeletepdffilesonclean;theymightberequiredimages.*#535: Fix LaTeX output generated for line blocks.*#544: Allow ``.pyw`` as a source file extension.Release1.0.4(Sep17,2010)============================*#524: Open intersphinx inventories in binary mode on Windows,sinceversion2containszlib-compresseddata.*#513: Allow giving non-local URIs for JavaScript files, e.g.intheJSMathextension.*#512: Fix traceback when ``intersphinx_mapping`` is empty.Release1.0.3(Aug23,2010)============================*#495: Fix internal vs. external link distinction for links comingfromadocutilstable-of-contents.*#494: Fix the ``maxdepth`` option for the ``toctree()`` templatecallablewhenusedwith``collapse=True``.*#507: Fix crash parsing Python argument lists containing bracketsinstringliterals.*#501: Fix regression when building LaTeX docs with figures thatdon't have captions.*#510: Fix inheritance diagrams for classes that are not picklable.*#497: Introduce separate background color for the sidebar collapsebutton,makingiteasiertosee.*#502, #503, #496: Fix small layout bugs in several builtin themes.Release1.0.2(Aug14,2010)============================*#490: Fix cross-references to objects of types added by the:func:`~.Sphinx.add_object_type`APIfunction.*Fixhandlingofdocfieldtypesfordifferentdirectivetypes.*Allowbreakinglongsignatures,continuingwithbacklash-escapednewlines.*FixunwantedstylingofCdomainreferences(becauseofanamespaceclashwithPygmentsstyles).*AllowreferencestoPEPsandRFCswithexplicitanchors.*#471: Fix LaTeX references to figures.*#482: When doing a non-exact search, match only the given typeofobject.*#481: Apply non-exact search for Python reference targets with``.name``formodulestoo.*#484: Fix crash when duplicating a parameter in an info field list.*#487: Fix setting the default role to one provided by the``oldcmarkup``extension.*#488: Fix crash when json-py is installed, which provides a``json``modulebutisincompatibletosimplejson.*#480: Fix handling of target naming in intersphinx.*#486: Fix removal of ``!`` for all cross-reference roles.Release1.0.1(Jul27,2010)============================*#470: Fix generated target names for reST domain objects; theyarenotinthesamenamespace.*#266: Add Bengali language.*#473: Fix a bug in parsing JavaScript object names.*#474: Fix building with SingleHTMLBuilder when there is no toctree.*Fixdisplaynamesforobjectslinkedtobyintersphinxwithexplicittargets.*FixbuildingwiththeJSONbuilder.*FixhyperrefsinobjectdescriptionsforLaTeX.Release1.0(Jul23,2010)==========================Incompatiblechanges--------------------*Supportfordomainshasbeenadded.Adomainisacollectionofdirectivesandrolesthatalldescribeobjectsbelongingtogether,e.g.elementsofaprogramminglanguage.Afewbuiltindomainsareprovided:-Python-C-C++-JavaScript-reStructuredText*TheoldmarkupfordefiningandlinkingtoCdirectivesisnowdeprecated.Itwillnotworkanymoreinfutureversionswithoutactivatingthe:mod:`~sphinx.ext.oldcmarkup`extension;inSphinx1.0,itisactivatedbydefault.*Removedsupportforolddependencyversions;requirementsarenow:-docutils>=0.5-Jinja2>=2.2*Removeddeprecatedelements:-``exclude_dirs``configvalue-``sphinx.builder``moduleFeaturesadded--------------*General:-Addeda"nitpicky"modethatemitswarningsforallmissingreferences.Itisactivatedbythe:option:`-n`command-lineswitchorthe:confval:`nitpicky`configvalue.-Added``latexpdf``targetinquickstartMakefile.*Markup:-The:rst:role:`menuselection`and:rst:role:`guilabel`rolesnowsupportampersandaccelerators.-Newmorecompactdocfieldsyntaxisnowrecognized:``:paramtypename:description``.-Added``tab-width``optionto:rst:dir:`literalinclude`directive.-Added``titlesonly``optionto:rst:dir:`toctree`directive.-Addedthe``prepend``and``append``optionstothe:rst:dir:`literalinclude`directive.-#284: All docinfo metadata is now put into the document metadata, notjusttheauthor.-The:rst:role:`ref`rolecannowalsoreferencetablesbycaption.-The:rst:dir:`include`directivenowsupportsabsolutepaths,whichareinterpretedasrelativetothesourcedirectory.-InthePythondomain,referenceslike``:func:`.name```nowlookformatchingnameswithanyprefixifnodirectmatchisfound.*Configuration:-Added:confval:`rst_prolog`configvalue.-Added:confval:`html_secnumber_suffix`configvaluetocontrolsectionnumberingformat.-Added:confval:`html_compact_lists`configvaluetocontroldocutils' compact lists feature.-The:confval:`html_sidebars`configvaluecannowcontainpatternsaskeys,andthevaluescanbeliststhatexplicitlyselectwhichsidebartemplatesshouldberendered.Thatmeansthatthebuiltinsidebarcontentscanbeincludedonlyselectively.-:confval:`html_static_path`cannowcontainsinglefileentries.-Thenewuniversalconfigvalue:confval:`exclude_patterns`makestheold:confval:`unused_docs`,:confval:`exclude_trees`and:confval:`exclude_dirnames`obsolete.-Added:confval:`html_output_encoding`configvalue.-Addedthe:confval:`latex_docclass`configvalueandmadethe"twoside"documentclassoptionoverridableby"oneside".-Addedthe:confval:`trim_doctest_flags`configvalue,whichistruebydefault.-Added:confval:`html_show_copyright`configvalue.-Added:confval:`latex_show_pagerefs`and:confval:`latex_show_urls`configvalues.-Thebehaviorof:confval:`html_file_suffix`changedslightly:theemptystringnowmeans"no suffix"insteadof"default suffix",use``None``for"default suffix".*Newbuilders:-AddedabuilderfortheEpubformat.-Addedabuilderformanualpages.-Addedasingle-fileHTMLbuilder.*HTMLoutput:-InlinerolesnowgetaCSSclasswiththeirname,allowingstylestocustomizetheirappearance.Domain-specificrolesgettwoclasses,``domain``and``domain-rolename``.-Referencesnowgettheclass``internal``iftheyareinternaltothewholeproject,asopposedtointernaltothecurrentpage.-Externalreferencescanbestyleddifferentlywiththenew``externalrefs``themeoptionforthedefaulttheme.-Inthedefaulttheme,thesidebarcanexperimentallynowbemadecollapsibleusingthenew``collapsiblesidebar``themeoption.-#129: Toctrees are now wrapped in a ``div`` tag with class``toctree-wrapper``inHTMLoutput.-The:data:`toctree`callableintemplatesnowhasa``maxdepth``keywordargumenttocontrolthedepthofthegeneratedtree.-The:data:`toctree`callableintemplatesnowacceptsa``titles_only``keywordargument.-Added``htmltitle``blockinlayouttemplate.-IntheJavaScriptsearch,allowsearchingforobjectnamesincludingthemodulename,like``sys.argv``.-Addednewtheme``haiku``,inspiredbytheHaikuOSuserguide.-Addednewtheme``nature``.-Addednewtheme``agogo``,createdbyAndiAlbrecht.-Addednewtheme``scrolls``,createdbyArminRonacher.-#193: Added a ``visitedlinkcolor`` theme option to the defaulttheme.-#322: Improved responsiveness of the search page by loading thesearchindexasynchronously.*ExtensionAPI:-Added:event:`html-collect-pages`.-Added:confval:`needs_sphinx`configvalueand:meth:`~sphinx.application.Sphinx.require_sphinx`applicationAPImethod.-#200: Added :meth:`~sphinx.application.Sphinx.add_stylesheet`applicationAPImethod.*Extensions:-Addedthe:mod:`~sphinx.ext.viewcode`extension.-Addedthe:mod:`~sphinx.ext.extlinks`extension.-Addedsupportforsourceorderingofmembersinautodoc,with``autodoc_member_order='bysource'``.-Added:confval:`autodoc_default_flags`configvalue,whichcanbeusedtoselectdefaultflagsforallautodocdirectives.-Addedawayforintersphinxtorefertonamedlabelsinotherprojects,andtospecifytheprojectyouwanttolinkto.-#280: Autodoc can now document instance attributes assigned in``__init__``methods.-Manyimprovementsandfixestothe:mod:`~sphinx.ext.autosummary`extension,thankstoPauliVirtanen.-#309: The :mod:`~sphinx.ext.graphviz` extension can now output SVGinsteadofPNGimages,controlledbythe:confval:`graphviz_output_format`configvalue.-Added``alt``optionto:rst:dir:`graphviz`extensiondirectives.-Added``exclude``argumentto:func:`.autodoc.between`.*Translations:-AddedCroatiantranslation,thankstoBojanMihelač.-AddedTurkishtranslation,thankstoFiratOzgul.-AddedCatalantranslation,thankstoPauFernández.-AddedsimplifiedChinesetranslation.-AddedDanishtranslation,thankstoHjorthLarsen.-AddedLithuaniantranslation,thankstoDaliusDobravolskas.*Bugsfixed:-#445: Fix links to result pages when using the search functionofHTMLbuiltwiththe``dirhtml``builder.-#444: In templates, properly re-escape values treated with the"striptags"Jinjafilter.Release0.6.7(Jun05,2010)============================*#440: Remove usage of a Python >= 2.5 API in the ``literalinclude``directive.*FixabugthatpreventedsomereferencesbeinggeneratedintheLaTeXbuilder.*#428: Add some missing CSS styles for standard docutils classes.*#432: Fix UnicodeErrors while building LaTeX in translated locale.Release0.6.6(May25,2010)============================*Handlerawnodesinthe``text``writer.*FixaproblemtheQthelpprojectgeneratedbythe``qthelp``builderthatwouldleadtonocontentbeingdisplayedintheQtAssistant.*#393: Fix the usage of Unicode characters in mathematic formulaswhenusingthe``pngmath``extension.*#404: Make ``\and`` work properly in the author field of the``latex_documents``setting.*#409: Make the ``highlight_language`` config value work properlyintheLaTeXbuilder.*#418: Allow relocation of the translation JavaScript files tothesystemdirectoryonUnixsystems.*#414: Fix handling of Windows newlines in files included withthe``literalinclude``directive.*#377: Fix crash in linkcheck builder.*#387: Fix the display of search results in ``dirhtml`` output.*#376: In autodoc, fix display of parameter defaults containingbackslashes.*#370: Fix handling of complex list item labels in LaTeX output.*#374: Make the ``doctest_path`` config value of the doctestextensionactuallywork.*FixthehandlingofmultipletoctreeswhencreatingtheglobalTOCforthe``toctree()``templatefunction.*FixthehandlingofhiddentoctreeswhencreatingtheglobalTOCforthe``toctree()``templatefunction.*Fixthehandlingofnestedlistsinthetextwriter.*#362: In autodoc, check for the existence of ``__self__`` onfunctionobjectsbeforeaccessingit.*#353: Strip leading and trailing whitespace when extractingsearchwordsinthesearchfunction.Release0.6.5(Mar01,2010)============================*Inautodoc,fixtheomissionofsomemodulemembersexplicitlydocumentedusingdocumentationcomments.*#345: Fix cropping of sidebar scroll bar with ``stickysidebar``optionofthedefaulttheme.*#341: Always generate UNIX newlines in the quickstart Makefile.*#338: Fix running with ``-C`` under Windows.*Inautodoc,allowcustomizingthesignatureofanobjectwherethebuilt-inmechanismfails.*#331: Fix output for enumerated lists with start values in LaTeX.*Makethe``start-after``and``end-before``optionstothe``literalinclude``directiveworkcorrectlyifnotusedtogether.*#321: Fix link generation in the LaTeX builder.Release0.6.4(Jan12,2010)============================*Improvethehandlingofnon-Unicodestringsintheconfiguration.*#316: Catch OSErrors occurring when calling graphviz withargumentsitdoesn't understand.*RestorecompatibilitywithPygments>=1.2.*#295: Fix escaping of hyperref targets in LaTeX output.*#302: Fix links generated by the ``:doc:`` role for LaTeX output.*#286: collect todo nodes after the whole document has been read;thisallowsplacingsubstitutionreferencesintodoitems.*#294: do not ignore an explicit ``today`` config value in aLaTeXbuild.*The``alt``textofinheritancediagramsisnowmuchcleaner.*Ignoreimagesinsectiontitleswhengeneratinglinkcaptions.*#310: support exception messages in the ``testoutput`` blocks ofthe``doctest``extension.*#293: line blocks are styled properly in HTML output.*#285: make the ``locale_dirs`` config value work again.*#303: ``html_context`` values given on the command line via ``-A``shouldnotoverrideothervaluesgiveninconf.py.*Fixabugpreventingincrementalrebuildsforthe``dirhtml``builder.*#299: Fix the mangling of quotes in some literal blocks.*#292: Fix path to the search index for the ``dirhtml`` builder.*FixaJythoncompatibilityissue:makethedependenceonthe``parser``moduleoptional.*#238: In autodoc, catch all errors that occur on module import,notjust``ImportError``.*Fixthehandlingofnon-data,butnon-methoddescriptorsinautodoc.*Whencopyingfiletimes,ignoreOSErrorsraisedby``os.utime()``.Release0.6.3(Sep03,2009)============================*ProperlyaddCmodulefilenamesasdependenciesinautodoc.*#253: Ignore graphviz directives without content instead ofraisinganunhandledexception.*#241: Fix a crash building LaTeX output for documents that containatodolistdirective.*#252: Make it easier to change the build dir in the Makefilesgeneratedbyquickstart.*#220: Fix CSS so that displaymath really is centered.*#222: Allow the "Footnotes" header to be translated.*#225: Don't add whitespace in generated HTML after inline tags.*#227: Make ``literalinclude`` work when the document's pathnamecontainsnon-ASCIIcharacters.*#229: Fix autodoc failures with members that raise errorson``getattr()``.*#205: When copying files, don't copy full stat info, onlymodificationtimes.*#232: Support non-ASCII metadata in Qt help builder.*ProperlyformatbulletlistsnestedindefinitionlistsforLaTeX.*Sectiontitlesarenowallowedinside``only``directives.*#201: Make ``centered`` directive work in LaTeX output.*#206: Refuse to overwrite an existing master document insphinx-quickstart.*#208: Use MS-sanctioned locale settings, determined by the``language``configoption,intheHTMLhelpbuilder.*#210: Fix nesting of HTML tags for displayed math from pngmathextension.*#213: Fix centering of images in LaTeX output.*#211: Fix compatibility with docutils 0.5.Release0.6.2(Jun16,2009)============================*#130: Fix obscure IndexError in doctest extension.*#167: Make glossary sorting case-independent.*#196: Add a warning if an extension module doesn't have a``setup()``function.*#158: Allow '..' in template names, and absolute template paths;Jinja2bydefaultdisablesboth.*WhenhighlightingPythoncode,ignoreextraindentationbeforetryingtoparseitasPython.*#191: Don't escape the tilde in URIs in LaTeX.*Don't consider contents of source comments for the search index.*Setthedefaultencodingto``utf-8-sig``tohandlefileswithaUTF-8BOMcorrectly.*#178: apply ``add_function_parentheses`` config value to Cfunctionsaspromised.*#173: Respect the docutils ``title`` directive.*#172: The ``obj`` role now links to modules as promised.*#19: Tables now can have a "longtable" class, in order to getcorrectlybrokenintopagesinLaTeXoutput.*LookforSphinxmessagecatalogsinthesystemdefaultpathbeforetrying``sphinx/locale``.*Fixthesearchformethodsvia"classname.methodname".*#155: Fix Python 2.4 compatibility: exceptions are old-styleclassesthere.*#150: Fix display of the "sphinxdoc" theme on Internet Explorerversions6and7.*#146: Don't fail to generate LaTeX when the user has an active``.docutils``configuration.*#29: Don't generate visible "-{-}" in option lists in LaTeX.*Fixcross-referenceroleswhenputintosubstitutions.*Don't put image "alt" text into table-of-contents entries.*IntheLaTeXwriter,donotraiseanexceptionontoomanysectionlevels,justusethe"subparagraph"levelforallofthem.*#145: Fix autodoc problem with automatic members that refuse to begetattr()'d from their parent.*Ifspecificfilenamestobuildaregivenonthecommandline,checkthattheyarewithinthesourcedirectory.*Fixautodoccrashforobjectswithouta``__name__``.*Fixintersphinxforinstallationswithouturllib2.HTTPSHandler.*#134: Fix pending_xref leftover nodes when using the todolistdirectivefromthetodoextension.Release0.6.1(Mar26,2009)============================*#135: Fix problems with LaTeX output and the graphviz extension.*#132: Include the autosummary "module" template in the distribution.Release0.6(Mar24,2009)==========================Newfeaturesadded------------------*Incompatiblechanges:-TemplatingnowrequirestheJinja2library,whichisanenhancedversionoftheoldJinja1engine.Sincethesyntaxandsemanticislargelythesame,veryfewfixesshouldbenecessaryincustomtemplates.-The"document"divtaghasbeenmovedoutofthe``layout.html``template's "document" block, because the closing tag was alreadyoutside.Ifyouoverwritethisblock,youneedtoremoveyour"document"divtagaswell.-The``autodoc_skip_member``eventnowalsogetstodecidewhethertoskipmemberswhosenamestartswithunderscores.Previously,thesememberswerealwaysautomaticallyskipped.Therefore,ifyouhandlethisevent,addsomethinglikethistoyoureventhandlertorestoretheoldbehavior::ifname.startswith('_'):returnTrue*Themingsupport,seethenewsectioninthedocumentation.*Markup:-Duetopopulardemand,addeda``:doc:``rolewhichdirectlylinkstoanotherdocumentwithouttheneedofcreatingalabeltowhicha``:ref:``couldlinkto.-#4: Added a ``:download:`` role that marks a non-document fileforinclusionintotheHTMLoutputandlinkstoit.-Addedan``only``directivethatcanselectivelyincludetextbasedonenabled"tags".Tagscanbegivenonthecommandline.Also,thecurrentbuilderoutputformat(e.g."html"or"latex")isalwaysadefinedtag.-#10: Added HTML section numbers, enabled by giving a``:numbered:``flagtothe``toctree``directive.-#114: Added an ``abbr`` role to markup abbreviations andacronyms.-The``literalinclude``directivenowsupportsseveralmoreoptions,toincludeonlypartsofafile.-The``toctree``directivenowsupportsa``:hidden:``flag,whichwillpreventlinksfrombeinggeneratedinplaceofthedirective--thisallowsyoutodefineyourdocumentstructure,butplacethelinksyourself.-#123: The ``glossary`` directive now supports a ``:sorted:``flagthatsortsglossaryentriesalphabetically.-Pathstoimages,literalincludefilesanddownloadfilescannowbeabsolute(like``/images/foo.png``).Theyaretreatedasrelativetothetopsourcedirectory.-#52: There is now a ``hlist`` directive, creating a compactlistbyplacingdistributingitemsintomultiplecolumns.-#77: If a description environment with info field list onlycontainsone``:param:``entry,nobulletlistisgenerated.-#6: Don't generate redundant ``<ul>`` for top-level TOC treeitems,whichleadstoavisualseparationofTOCentries.-#23: Added a ``classmethod`` directive along with ``method``and``staticmethod``.-Scaledimagesnowgetalinktotheunscaledversion.-SVGimagesarenowsupportedinHTML(via``<object>``and``<embed>``tags).-Addeda``toctree``callabletothetemplates,andtheabilitytoincludeexternallinksintoctrees.The'collapse'keywordargumentindicateswhetherornottoonlydisplaysubitemsofthecurrentpage.(DefaultstoTrue.)*Configuration:-Thenewconfigvalue``rst_epilog``cancontainreSTthatisappendedtoeachsourcefilethatisread.Thisistherightplaceforglobalsubstitutions.-Thenew``html_add_permalinks``configvaluecanbeusedtoswitchoffthegenerated"paragraph sign"permalinksforeachheadinganddefinitionenvironment.-Thenew``html_show_sourcelink``configvaluecanbeusedtoswitchoffthelinkstothereSTsourcesinthesidebar.-Thedefaultvaluefor``htmlhelp_basename``isnowtheprojecttitle,cleanedupasafilename.-Thenew``modindex_common_prefix``configvaluecanbeusedtoignorecertainpackagenamesformoduleindexsorting.-Thenew``trim_footnote_reference_space``configvaluemirrorsthedocutilsconfigvalueofthesamenameandremovesthespacebeforeafootnotereferencethatisnecessaryforreSTtorecognizethereference.-Thenew``latex_additional_files``configvaluecanbeusedtocopyfiles(thatSphinxdoesn't copy automatically, e.g. if theyarereferencedincustomLaTeXaddedin``latex_elements``)tothebuilddirectory.*Builders:-TheHTMLbuildernowstoresasmallfilenamed``.buildinfo``initsoutputdirectory.Itstoresahashofconfigvaluesthatcanbeusedtodetermineifafullrebuildneedstobedone(e.g.afterchanging``html_theme``).-NewbuilderforQthelpcollections,byAntonioValentino.-Thenew``DirectoryHTMLBuilder``(shortname``dirhtml``)createsaseparatedirectoryforeverypage,andplacesthepagethereinafilecalled``index.html``.Therefore,pageURLsandlinksdon't need to contain ``.html``.-Thenew``html_link_suffix``configvaluecanbeusedtoselectthesuffixofgeneratedlinksbetweenHTMLfiles.-#96: The LaTeX builder now supports figures wrapped by text, whenusingthe``figwidth``optionandright/leftalignment.*Newtranslations:-ItalianbySandroDentella.-UkrainianbyPetroSasnyk.-FinnishbyJukkaInkeri.-RussianbyAlexanderSmishlajev.*ExtensionsandAPI:-New``graphviz``extensiontoembedgraphvizgraphs.-New``inheritance_diagram``extensiontoembed...inheritancediagrams!-New``autosummary``extensionthatgeneratessummariesofmodulesandautomaticdocumentationofmodules.-AutodocnowhasareusablePythonAPI,whichcanbeusedtocreatecustomtypesofobjectstoauto-document(e.g.Zopeinterfaces).Seealso``Sphinx.add_autodocumenter()``.-Autodocnowhandlesdocumentedattributes.-Autodocnowhandlesinnerclassesandtheirmethods.-Autodoccandocumentclassesasfunctionsnowifexplicitlymarkedwith`autofunction`.-Autodoccannowexcludesinglemembersfromdocumentationviathe``exclude-members``option.-Autodoccannowordermemberseitheralphabetically(likepreviously)orbymembertype;configurableeitherwiththeconfigvalue``autodoc_member_order``ora``member-order``optionperdirective.-Thefunction``Sphinx.add_directive()``nowalsosupportsdocutils0.5-styledirectiveclasses.Iftheyinheritfrom``sphinx.util.compat.Directive``,theyalsoworkwithdocutils0.4.-Thereisnowa``Sphinx.add_lexer()``methodtobeabletousecustomPygmentslexerseasily.-Thereisnow``Sphinx.add_generic_role()``tomirrorthedocutils' own function.*Otherchanges:-Configoverridesforsingledictkeyscannowbegivenonthecommandline.-Thereisnowa``doctest_global_setup``configvaluethatcanbeusedtogivesetupcodeforalldoctestsinthedocumentation.-SourcelinksinHTMLarenowgeneratedwith``rel="nofollow"``.-QuickstartcannowgenerateaWindows``make.bat``file.-#62: There is now a ``-w`` option for sphinx-build that writeswarningstoafile,inadditiontostderr.-Thereisnowa``-W``optionforsphinx-buildthatturnswarningsintoerrors.Release0.5.2(Mar24,2009)============================*Properlyescape``|``inLaTeXoutput.*#71: If a decoding error occurs in source files, print awarningandreplacethecharactersby"?".*FixaproblemintheHTMLsearchiftheindextakestoolongtoload.*Don't output system messages while resolving, because theywouldstayinthedoctreesevenifkeep_warningsisfalse.*#82: Determine the correct path for dependencies noted bydocutils.Thisfixesbehaviorwhereasourcewithdependentfileswasalwaysreportedaschanged.*Recognizetoctreedirectivesthatarenotonsectiontoplevel,butwithinblockitems,suchastables.*UseanewRFCbaseURL,sincerfc.orgseemsdown.*Fixacrashinthetodolistdirectivewhennotodoitemsaredefined.*Don't call LaTeX or dvipng over and over again if it was notfoundonce,andusetext-onlylatexasasubstituteinthatcase.*FixproblemswithfootnotesintheLaTeXoutput.*Preventdoublehyphensbecomingen-dashesinliteralcodeintheLaTeXoutput.*Openliteralincludefilesinuniversalnewlinemodetoallowarbitrarynewlineconventions.*Actuallymakethe``-Q``optionwork.*#86: Fix explicit document titles in toctrees.*#81: Write environment and search index in a manner that is safefromexceptionsthatoccurduringdumping.*#80: Fix UnicodeErrors when a locale is set with setlocale().Release0.5.1(Dec15,2008)============================*#67: Output warnings about failed doctests in the doctest extensionevenwhenrunninginquietmode.*#72: In pngmath, make it possible to give a full path to LaTeX anddvipngonWindows.Forthattowork,the``pngmath_latex``and``pngmath_dvipng``optionsarenolongersplitintocommandandadditionalarguments;use``pngmath_latex_args``and``pngmath_dvipng_args``togiveadditionalarguments.*Don't crash on failing doctests with non-ASCII characters.*Don't crash on writing status messages and warnings containingunencodablecharacters.*Warnifadoctestextensionblockdoesn't contain any code.*Fixthehandlingof``:param:``and``:type:``docfieldswhentheycontainmarkup(especiallycross-referencingroles).*#65: Fix storage of depth information for PNGs generated by thepngmathextension.*Fixautodoccrashwhenautomethodisusedoutsideaclasscontext.*#68: Fix LaTeX writer output for images with specified height.*#60: Fix wrong generated image path when including images in sourcesinsubdirectories.*FixtheJavaScriptsearchwhenhtml_copy_sourceisoff.*Fixanindentationprobleminautodocwhendocumentingclasseswiththeoption``autoclass_content="both"``set.*Don't crash on empty index entries, only emit a warning.*FixatypointhesearchJavaScriptcode,leadingtounusablesearchfunctioninsomesetups.Release0.5(Nov23,2008)--Birthdayrelease!===============================================Newfeaturesadded------------------*Markupfeatures:-Citationsarenowglobal:allcitationdefinedinanyfilecanbereferencedfromanyfile.CitationsarecollectedinabibliographyforLaTeXoutput.-FootnotesarenowproperlyhandledintheLaTeXbuilder:theyappearatthelocationofthefootnotereferenceintext,notattheendofasection.ThankstoAndrewMcNamarafortheinitialpatch.-"System Message"warningsarenowautomaticallyremovedfromthebuiltdocumentation,andonlywrittentostderr.Ifyouwanttheoldbehavior,setthenewconfigvalue``keep_warnings``toTrue.-Glossaryentriesarenowautomaticallyaddedtotheindex.-Figureswithcaptionscannowbereferredtolikesectiontitles,usingthe``:ref:``rolewithoutanexplicitlinktext.-Added``cmember``roleforconsistency.-ListsenumeratedbylettersorromannumeralsarenowhandledlikeinstandardreST.-The``seealso``directivecannowalsobegivenarguments,asashortform.-Youcannowdocumentseveralprogramsandtheiroptionswiththenew``program``directive.*HTMLoutputandtemplates:-Incompatiblechange:The"root"relationlink(topleftintherelbar)nowpointstothe``master_doc``bydefault,nolongertoadocumentcalled"index".Theoldbehavior,whileusefulinsomesituations,wassomewhatunexpected.Overridethe"rootrellink"blockinthetemplatetocustomizewhereitrefersto.-TheJavaScriptsearchnowsearchesforobjectsbeforesearchinginthefulltext.-TOCtreeentriesnowhaveCSSclassesthatmakeitpossibletostylethemdependingontheirdepth.-HighlightedcodeblocksnowhaveCSSclassesthatmakeitpossibletostylethemdependingontheirlanguage.-HTML``<meta>``tagsviathedocutils``meta``directivearenowsupported.-``SerializingHTMLBuilder``wasaddedasnewabstractbuilderthatcanbesubclassedtoserializebuildHTMLinaspecificformat.The``PickleHTMLBuilder``isaconcretesubclassofitthatusespickleasserializationimplementation.-``JSONHTMLBuilder``wasaddedasanother``SerializingHTMLBuilder``subclassthatdumpsthegeneratedHTMLintoJSONfilesforfurtherprocessing.-The``rellinks``blockinthelayouttemplateisnowcalled``linktags``toavoidconfusionwiththerelbarlinks.-TheHTMLbuildershavetwoadditionalattributesnowthatcanbeusedtodisabletheanchor-linkcreationafterheadlinesanddefinitionlinks.-Onlygenerateamoduleindexiftherearesomemodulesinthedocumentation.*Newandchangedconfigvalues:-Addedsupportforinternationalizationingeneratedtextwiththe``language``and``locale_dirs``configvalues.Manythankstolanguagecontributors:*HorstGutmann--German*PavelKosina--Czech*DavidLarlet--French*MichałKandulski--Polish*YasushiMasuda--Japanese*GuillemBorrell--Spanish*LucSaffreandPeterBertels--Dutch*FredLin--TraditionalChinese*RogerDemetrescu--BrazilianPortuguese*RokGarbas--Slovenian-Thenewconfigvalue``highlight_language``setaglobaldefaultforhighlighting.When``'python3'``isselected,consoleoutputblocksarerecognizedlikefor``'python'``.-ExposedPygments' lexer guessing as a highlight "language" ``guess``.-Thenewconfigvalue``latex_elements``allowstooverrideallLaTeXsnippetsthatSphinxputsintothegenerated.texfilebydefault.-Added``exclude_dirnames``configvaluethatcanbeusedtoexcludee.g.CVSdirectoriesfromsourcefilesearch.-Added``source_encoding``configvaluetoselectinputencoding.*Extensions:-Thenewextensions``sphinx.ext.jsmath``and``sphinx.ext.pngmath``providemathsupportforbothHTMLandLaTeXbuilders.-Thenewextension``sphinx.ext.intersphinx``half-automaticallycreateslinkstoSphinxdocumentationofPythonobjectsinotherprojects.-Thenewextension``sphinx.ext.todo``allowstheinsertionof"To do"directiveswhosevisibilityintheoutputcanbetoggled.Italsoaddsadirectivetocompilealistofalltodoitems.-sphinx.ext.autodochasanewevent``autodoc-process-signature``thatallowstuningfunctionsignatureintrospection.-sphinx.ext.autodochasanewevent``autodoc-skip-member``thatallowstuningwhichmembersareincludedinthegeneratedcontent.-Respect__all__whenautodocumentingmodulemembers.-The`automodule`directivenowsupportsthe``synopsis``,``deprecated``and``platform``options.*ExtensionAPI:-``Sphinx.add_node()``nowtakesoptionalvisitormethodsfortheHTML,LaTeXandtexttranslators;thispreventshavingtomanuallypatchtheclasses.-Added``Sphinx.add_javascript()``thataddsscriptstoloadinthedefaultHTMLtemplate.-Addednewevents:``source-read``,``env-updated``,``env-purge-doc``,``missing-reference``,``build-finished``.*Otherchanges:-Addedacommand-lineswitch``-Q``:itwillsuppresswarnings.-Addedacommand-lineswitch``-A``:itcanbeusedtosupplyadditionalvaluesintotheHTMLtemplates.-Addedacommand-lineswitch``-C``:ifitisgiven,noconfigurationfile``conf.py``isrequired.-Addedadistutilscommand`build_sphinx`:WhenSphinxisinstalled,youcancall``pythonsetup.pybuild_sphinx``forprojectsthathaveSphinxdocumentation,whichwillbuildthedocsandplacetheminthestandarddistutilsbuilddirectory.-Inquickstart,iftheselectedrootpathalreadycontainsaSphinxproject,complainandabort.Bugsfixed----------*#51: Escape configuration values placed in HTML templates.*#44: Fix small problems in HTML help index generation.*FixLaTeXoutputforlineblocksintables.*#38: Fix "illegal unit" error when using pixel image widths/heights.*SupporttablecaptionsinLaTeXoutput.*#39: Work around a bug in Jinja that caused "<generator ...>" to beemittedinHTMLoutput.*FixaproblemwithmodulelinksnotbeinggeneratedinLaTeXoutput.*Fixthehandlingofimagesindifferentdirectories.*#29: Support option lists in the text writer. Make sure that dashesintroducinglongoptionnamesarenotcontractedtoen-dashes.*Supportthe"scale"optionforimagesinHTMLoutput.*#25: Properly escape quotes in HTML help attribute values.*FixLaTeXbuildforsomedescriptionenvironmentswith``:noindex:``.*#24: Don't crash on uncommon casing of role names (like ``:Class:``).*OnlyoutputANSIcolorsoncolorterminals.*Updatetonewestfncychap.sty,tofixproblemswithnon-ASCIIcharactersatthestartofchaptertitles.*FixaproblemwithindexgenerationinLaTeXoutput,causedbyhyperrefnotbeingincludedlast.*Don't disregard return annotations for functions without any parameters.*Don't throw away labels for code blocks.Release0.4.3(Oct8,2008)===========================*Fixabuginautodocwithdirectlygivenautodocmembers.*Fixabuginautodocthatwouldimportamoduletwice,onceas"module",onceas"module.".*FixabugintheHTMLwriterthatcreatedduplicate``id``attributesforsectiontitleswithdocutils0.5.*Properlycall``super()``inoverriddenblocksintemplates.*AddafixwhenusingXeTeX.*UnifyhandlingofLaTeXescaping.*Rebuildeverythingwhenthe``extensions``configvaluechanges.*Don't try to remove a nonexisting static directory.*Fixanindentationprobleminproductionlists.*Fixencodinghandlingforliteralincludefiles:``literalinclude``nowhasan``encoding``optionthatdefaultstoUTF-8.*Fixthehandlingofnon-ASCIIcharactersenteredinquickstart.*FixacrashwithnonexistingimageURIs.Release0.4.2(Jul29,2008)============================*Fixrenderingofthe``samp``roleinHTML.*FixabugwithLaTeXlinkstoheadingsleadingtoawrongpage.*Rereaddocumentswithglobbedtoctreeswhensourcefilesareaddedorremoved.*AddamissingparametertoPickleHTMLBuilder.handle_page().*Putinheritanceinfoalwaysonitsownline.*Don't automatically enclose code with whitespace in it in quotes;onlydothisforthe``samp``role.*autodocnowemitsamorepreciseerrormessagewhenamodulecan't be imported or an attribute can'tbefound.*TheJavaScriptsearchnowusesthecorrectfilenamesuffixwhenreferringtofounditems.*Theautomoduledirectivenowacceptsthe``inherited-members``and``show-inheritance``optionsagain.*Youcannowrebuildthedocsnormallyafterrelocatingthesourceand/ordoctreedirectory.Release0.4.1(Jul5,2008)===========================*Addedsub-/superscriptnodehandlingtoTextBuilder.*Labelnamesinreferencesarenowcase-insensitive,sincereSTlabelnamesarealwayslowercased.*FixlinkcheckbuildercrashformalformedURLs.*Addcompatibilityforadmonitionsanddocutils0.5.*Removethesillyrestrictionon"rubric"intheLaTeXwriter:youcannowwritearbitrary"rubric"directives,andonlythosewithatitleof"Footnotes"willbeignored.*CopytheHTMLlogototheoutput``_static``directory.*FixLaTeXcodeformoduleswithunderscoresinnamesandplatforms.*FixacrashwithnonlocalimageURIs.*Allowtheusageof:noindex:in``automodule``directives,asdocumented.*Fixthe``delete()``docstringprocessorfunctioninautodoc.*Fixwarningmessagefornonexistingimages.*FixJavaScriptsearchinInternetExplorer.Release0.4(Jun23,2008)==========================Newfeaturesadded------------------*``tocdepth``canbegivenasafile-widemetadataentry,andspecifiesthemaximumdepthofaTOCofthisfile.*Thenewconfigvalue`default_role`canbeusedtoselectthedefaultroleforalldocuments.*Sphinxnowinterpretsfieldlistswithfieldslike``:paramfoo:``indescriptionunits.*Thenew`staticmethod`directivecanbeusedtomarkmethodsasstaticmethods.*HTMLoutput:-The"previous"and"next"linkshaveamorelogicalstructure,sothatbyfollowing"next"linksyoucantraversetheentireTOCtree.-Thenewevent`html-page-context`canbeusedtoincludecustomvaluesintothecontextusedwhenrenderinganHTMLtemplate.-Documentmetadataisnowinthedefaulttemplatecontext,underthename`metadata`.-Thenewconfigvalue`html_favicon`canbeusedtosetafaviconfortheHTMLoutput.ThankstoSebastianWiesner.-Thenewconfigvalue`html_use_index`canbeusedtoswitchindexgenerationinHTMLdocumentsoff.-Thenewconfigvalue`html_split_index`canbeusedtocreateseparateindexpagesforeachletter,tobeusedwhenthecompleteindexistoolargeforonepage.-Thenewconfigvalue`html_short_title`canbeusedtosetashortertitleforthedocumentationwhichisthenusedinthenavigationbar.-Thenewconfigvalue`html_show_sphinx`canbeusedtocontrolwhetheralinktoSphinxisaddedtotheHTMLfooter.-Thenewconfigvalue`html_file_suffix`canbeusedtosettheHTMLfilesuffixtoe.g.``.xhtml``.-Thedirectoriesinthe`html_static_path`cannowcontainsubdirectories.-Themoduleindexnowisn't collapsed if the number of submodulesislargerthanthenumberoftoplevelmodules.*Theimagedirectivenowsupportsspecifyingtheextensionas``.*``,whichmakesthebuilderselecttheonethatmatchesbest.ThankstoSebastianWiesner.*Thenewconfigvalue`exclude_trees`canbeusedtoexcludewholesubtreesfromthesearchforsourcefiles.*Defaultsforconfigurationvaluescannowbecallables,whichallowsdynamicdefaults.*ThenewTextBuildercreatesplain-textoutput.*Python3-stylesignatures,givingareturnannotationvia``->``,arenowsupported.*Extensions:-Theautodocextensionnowoffersamuchmoreflexiblewaytomanipulatedocstringsbeforeincludingthemintotheoutput,viathenew`autodoc-process-docstring`event.-The`autodoc`extensionacceptssignaturesforfunctions,methodsandclassesnowthatoverridethesignaturegotviaintrospectionfromPythoncode.-The`autodoc`extensionnowoffersa``show-inheritance``optionforautoclassthatinsertsalistofbasesafterthesignature.-Theautodocdirectivesnowsupportthe``noindex``flagoption.Bugsfixed----------*Correctlyreportthesourcelocationfordocstringsincludedwithautodoc.*FixtheLaTeXoutputofdescriptionunitswithmultiplesignatures.*HandlethefiguredirectiveinLaTeXoutput.*HandlerawadmonitionsinLaTeXoutput.*FixdeterminationofthetitleinHTMLhelpoutput.*Handleprojectnamescontainingspaces.*Don't write SSI-like comments in HTML output.*Renamethe"sidebar"classto"sphinxsidebar"inordertostaydifferentfromreSTsidebars.*UseabinaryTOCinHTMLhelpgenerationtofixissueslinkswithoutexplicitanchors.*Fixbehaviorofreferencestofunctions/methodswithanexplicittitle.*Supportcitation,subscriptandsuperscriptnodesinLaTeXwriter.*Providethestandard"class"directiveas"cssclass";elseitisshadowedbytheSphinx-defineddirective.*Fixthehandlingofexplicitmodulenamesgiventoautoclassdirectives.Theynowshowupwiththecorrectmodulenameinthegenerateddocs.*EnableautodoctoprocessUnicodedocstrings.*TheLaTeXwriternowtranslateslineblockswith``\raggedright``,whichplaysnicerwithtables.*FixbugwithdirectoriesintheHTMLbuilderstaticpath.Release0.3(May6,2008)=========================Newfeaturesadded------------------*The``toctree``directivenowsupportsa``glob``optionthatallowsglob-styleentriesinthecontent.*Ifthe`pygments_style`configvaluecontainsadotit's treated as theimportpathofacustomPygmentsstyleclass.*Anewconfigvalue,`exclude_dirs`,canbeusedtoexcludewholedirectoriesfromthesearchforsourcefiles.*Theconfigurationdirectory(containing``conf.py``)cannowbesetindependentlyfromthesourcedirectory.Forthat,anewcommand-lineoption``-c``hasbeenadded.*Anewdirective``tabularcolumns``canbeusedtogiveatabularcolumnspecificationforLaTeXoutput.Tablesnowusethe``tabulary``package.Literalblockscannowbeplacedintables,withseveralcaveats.*Anewconfigvalue,`latex_use_parts`,canbeusedtoenablepartsinLaTeXdocuments.*Autodocnowskipsinheritedmembersforclasses,unlessyougivethenew``inherited-members``option.*Anewconfigvalue,`autoclass_content`,selectsifthedocstringoftheclass' ``__init__`` method is added to the directive'sbody.*SupportforC++classnames(inthestyle``Class::Function``)inCfunctiondescriptions.*Supportfora``toctree_only``iteminitemsforthe``latex_documents``configvalue.ThisonlyincludesthedocumentsreferencedbyTOCtreesintheoutput,nottherestofthefilecontainingthedirective.Bugsfixed----------*sphinx.htmlwriter:CorrectlywritetheTOCfileforanystructureofthemasterdocument.Alsoencodenon-ASCIIcharactersasentitiesinTOCandindexfile.Removetworemaininginstancesofhard-coded"documentation".*sphinx.ext.autodoc:descriptorsaredetectedproperlynow.*sphinx.latexwriter:implementallreSTadmonitions,notjust``note``and``warning``.*LotsoflittlefixestotheLaTeXoutputandstyle.*FixOpenSearchtemplateandmaketemplateURLabsolute.The`html_use_opensearch`configvaluenowmustgivethebaseURL.*SomeunusedfilesarenowstrippedfromtheHTMLhelpfilebuild.Release0.2(Apr27,2008)==========================Incompatiblechanges--------------------*Jinja,thetemplateengineusedforthedefaultHTMLtemplates,isnownolongershippedwithSphinx.Ifitisnotinstalledautomaticallyforyou(itisnowlistedasadependencyin``setup.py``),installitmanuallyfromPyPI.Thiswillalsobeneededifyou're using Sphinx from a SVNcheckout;inthatcasepleasealsoremovethe``sphinx/jinja``directorythatmaybeleftoverfromoldrevisions.*Theclumsyhandlingofthe``index.html``templatewasremoved.Theconfigvalue``html_index``isgone,and``html_additional_pages``shouldbeusedinstead.Ifyouneedit,theold``index.html``templateisstillthere,called``defindex.html``,andyoucanportyourhtml_indextemplate,usingJinjainheritance,bychangingyourtemplate::{%extends"defindex.html"%}{%blocktables%}...oldhtml_indextemplatecontent...{%endblock%}andputting``'index':nameofyourtemplate``in``html_additional_pages``.*Inthelayouttemplate,redundant``block``\swereremoved;youshoulduseJinja's standard ``{{ super() }}`` mechanism instead, as explained in the(newlywritten)templatingdocs.Newfeaturesadded------------------*ExtensionAPI(Applicationobject):-Supportanewmethod,``add_crossref_type``.Itworkslike``add_description_unit``butthedirectivewillonlycreateatargetandnooutput.-Supportanewmethod,``add_transform``.Ittakesastandarddocutils``Transform``subclasswhichisthenappliedbySphinx' reader onparsingreSTdocumenttrees.-AddsupportforothertemplateenginesthanJinja,byaddinganabstractioncalleda"template bridge".Thisclasshandlesrenderingoftemplatesandcanbechangedusingthenewconfigurationvalue"template_bridge".-Theconfigfileitselfcanbeanextension(ifitprovidesa``setup()``function).*Markup:-Newdirective,``currentmodule``.Itcanbeusedtoindicatethemodulenameofthefollowingdocumentedthingswithoutcreatingindexentries.-Allowgivingadifferenttitletodocumentsinthetoctree.-Allowgivingmultipleoptionsina``cmdoption``directive.-Fixdisplayofclassmemberswithoutexplicitclassnamegiven.*Templates(HTMLoutput):-``index.html``renamedto``defindex.html``,seeabove.-There's a new config value, ``html_title``, that controls the overall"title"ofthesetofSphinxdocs.Itisusedinsteadeverywhereinsteadof"Projectname vX.Y documentation"now.-Allreferencesto"documentation"inthetemplateshavebeenremoved,sothatitisnoweasiertouseSphinxfornon-documentationdocumentswiththedefaulttemplates.-TemplatesnowhaveanXHTMLdoctype,tobeconsistentwithdocutils'HTMLoutput.-YoucannowcreateanOpenSearchdescriptionfilewiththe``html_use_opensearch``configvalue.-Youcannowquicklyincludealogointhesidebar,usingthe``html_logo``configvalue.-Therearenewblocksinthesidebar,sothatyoucaneasilyinsertcontentintothesidebar.*LaTeXoutput:-The``sphinx.sty``packagewascleanedofunusedstuff.-Youcanincludealogointhetitlepagewiththe``latex_logo``configvalue.-Youcandefinethelinkcolorsandaborderandbackgroundcolorforverbatimenvironments.ThankstoJacobKaplan-Moss,Talin,JeroenRuigrokvanderWervenandSebastianWiesnerforsuggestions.Bugsfixed----------*sphinx.ext.autodoc:Don't check ``__module__`` for explicitly givenmembers.Remove"self"inclassconstructorargumentlist.*sphinx.htmlwriter:Don't use os.path for joining image HREFs.*sphinx.htmlwriter:Don't use SmartyPants for HTML attribute values.*sphinx.latexwriter:Implementoptionlists.Also,someotherchangesweremadeto``sphinx.sty``inordertoenhancecompatibilityandremoveoldunusedstuff.ThankstoGaelVaroquauxforthat!*sphinx.roles:Fixreferencingglossarytermswithexplicittargets.*sphinx.environment:Don't swallow TOC entries when resolving subtrees.*sphinx.quickstart:Createasensibledefaultlatex_documentssetting.*sphinx.builder,sphinx.environment:Gracefullyhandlesomeusererrorcases.*sphinx.util:Followsymboliclinkswhensearchingfordocuments.Release0.1.61950(Mar26,2008)================================*sphinx.quickstart:FixformatstringforMakefile.Release0.1.61945(Mar26,2008)================================*sphinx.htmlwriter,sphinx.latexwriter:Supportthe``..image::``directivebycopyingimagefilestotheoutputdirectory.*sphinx.builder:Consistentlyname"special"HTMLoutputdirectorieswithaleadingunderscore;thismeans``_sources``and``_static``.*sphinx.environment:Takedependentfilesintoaccountwhencollectingthesetofoutdatedsources.*sphinx.directives:Recordfilesincludedwith``..literalinclude::``asdependencies.*sphinx.ext.autodoc:Recordfilesfromwhichdocstringsareincludedasdependencies.*sphinx.builder:RebuildallHTMLfilesincaseofatemplatechange.*sphinx.builder:HandleunavailabilityofTOCrelations(previous/nextchapter)moregracefullyintheHTMLbuilder.*sphinx.latexwriter:Includefncychap.stywhichdoesn't seem to beverycommoninTeXdistributions.Adda``clean``targetinthelatexMakefile.ReallypassthecorrectpaperandsizeoptionstotheLaTeXdocumentclass.*setup:OnPython2.4,don't egg-depend on docutils if a docutils isalreadyinstalled--elseitwillbeoverwritten.Release0.1.61843(Mar24,2008)================================*sphinx.quickstart:Reallydon't create a makefile if the userdoesn't want one.*setup:Don't install scripts twice, via setuptools entry pointsanddistutilsscripts.Onlyinstallviaentrypoints.*sphinx.builder:Don't recognize the HTML builder'scopiedsourcefiles(under``_sources``)asinputfilesifthesourcesuffixis``.txt``.*sphinx.highlighting:GeneratecorrectmarkupforLaTeXVerbatimenvironmentescapesevenifPygmentsisnotinstalled.*sphinx.builder:TheWebHTMLBuilderisnowcalledPickleHTMLBuilder.*sphinx.htmlwriter:Makeparsed-literalblocksworkasexpected,nothighlightingthemviaPygments.*sphinx.environment:Don't error out on reading an empty source file.Release0.1.61798(Mar23,2008)================================*sphinx:WorkwithdocutilsSVNsnapshotsaswellas0.4.*sphinx.ext.doctest:Makethegroupinwhichdoctestblocksareplacedselectable,anddefaultto``'default'``.*sphinx.ext.doctest:Replace``<BLANKLINE>``indoctestblocksbyrealblanklinesforpresentationoutput,andremovedoctestoptionsgiveninline.*sphinx.environment:Movedoctest_blocksoutofblock_quotestosupportindenteddoctestblocks.*sphinx.ext.autodoc:Render``..automodule::``docstringsinasectionnode,sothatmoduledocstringscancontainpropersectioning.*sphinx.ext.autodoc:Usethemodule's encoding for decodingdocstrings,ratherthanrequiringASCII.Release0.1.61611(Mar21,2008)================================*Firstpublicrelease.