[Checkins] SVN: zope.exceptions/branches/tseaver-no_2to3/ Add Sphinx docs.
Tres Seaver
cvs-admin at zope.org
Fri Apr 6 21:19:20 UTC 2012
Log message for revision 125038:
Add Sphinx docs.
Changed:
U zope.exceptions/branches/tseaver-no_2to3/.bzrignore
A zope.exceptions/branches/tseaver-no_2to3/docs/
A zope.exceptions/branches/tseaver-no_2to3/docs/Makefile
A zope.exceptions/branches/tseaver-no_2to3/docs/_static/
A zope.exceptions/branches/tseaver-no_2to3/docs/_templates/
A zope.exceptions/branches/tseaver-no_2to3/docs/api.rst
A zope.exceptions/branches/tseaver-no_2to3/docs/conf.py
A zope.exceptions/branches/tseaver-no_2to3/docs/index.rst
A zope.exceptions/branches/tseaver-no_2to3/docs/make.bat
A zope.exceptions/branches/tseaver-no_2to3/docs/narr.rst
U zope.exceptions/branches/tseaver-no_2to3/src/zope/exceptions/__init__.py
U zope.exceptions/branches/tseaver-no_2to3/src/zope/exceptions/interfaces.py
-=-
Modified: zope.exceptions/branches/tseaver-no_2to3/.bzrignore
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/.bzrignore 2012-04-06 19:50:02 UTC (rev 125037)
+++ zope.exceptions/branches/tseaver-no_2to3/.bzrignore 2012-04-06 21:19:17 UTC (rev 125038)
@@ -6,3 +6,4 @@
*.egg-info
.coverage
__pycache__
+docs/_build
Added: zope.exceptions/branches/tseaver-no_2to3/docs/Makefile
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/docs/Makefile (rev 0)
+++ zope.exceptions/branches/tseaver-no_2to3/docs/Makefile 2012-04-06 21:19:17 UTC (rev 125038)
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/zopeexceptions.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/zopeexceptions.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/zopeexceptions"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/zopeexceptions"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
Added: zope.exceptions/branches/tseaver-no_2to3/docs/api.rst
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/docs/api.rst (rev 0)
+++ zope.exceptions/branches/tseaver-no_2to3/docs/api.rst 2012-04-06 21:19:17 UTC (rev 125038)
@@ -0,0 +1,39 @@
+:mod:`zope.exceptions` API documentation
+========================================
+
+:py:mod:`zope.exceptions.interfaces`
+------------------------------------
+
+.. automodule:: zope.exceptions.interfaces
+
+
+:py:class:`~zope.exceptions.interfaces.ITracebackSupplement`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. autointerface:: zope.exceptions.interfaces.ITracebackSupplement
+ :members:
+ :member-order: source
+
+
+:py:mod:`zope.exceptions.exceptionformatter`
+--------------------------------------------
+
+.. automodule:: zope.exceptions.exceptionformatter
+
+
+:py:func:`~zope.exceptions.exceptionformatter.format_exception`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. autofunction:: zope.exceptions.exceptionformatter.format_exception
+
+
+:py:func:`~zope.exceptions.exceptionformatter.print_exception`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. autofunction:: zope.exceptions.exceptionformatter.print_exception
+
+
+:py:func:`~zope.exceptions.exceptionformatter.extract_stack`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. autofunction:: zope.exceptions.exceptionformatter.extract_stack
Added: zope.exceptions/branches/tseaver-no_2to3/docs/conf.py
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/docs/conf.py (rev 0)
+++ zope.exceptions/branches/tseaver-no_2to3/docs/conf.py 2012-04-06 21:19:17 UTC (rev 125038)
@@ -0,0 +1,254 @@
+# -*- coding: utf-8 -*-
+#
+# zope.exceptions documentation build configuration file, created by
+# sphinx-quickstart on Fri Apr 6 16:11:13 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.viewcode',
+ 'repoze.sphinx.autointerface',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'zope.exceptions'
+copyright = u'2012, Zope Foundation contributors.'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '4.0'
+# The full version, including alpha/beta/rc tags.
+release = '4.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'zopeexceptionsdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'zopeexceptions.tex', u'zope.exceptions Documentation',
+ u'Zope Foundation contributors.', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'zopeexceptions', u'zope.exceptions Documentation',
+ [u'Zope Foundation contributors.'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'zopeexceptions', u'zope.exceptions Documentation',
+ u'Zope Foundation contributors.', 'zopeexceptions', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
Added: zope.exceptions/branches/tseaver-no_2to3/docs/index.rst
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/docs/index.rst (rev 0)
+++ zope.exceptions/branches/tseaver-no_2to3/docs/index.rst 2012-04-06 21:19:17 UTC (rev 125038)
@@ -0,0 +1,19 @@
+:mod:`zope.exceptions` documentation
+====================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ narr
+ api
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
Added: zope.exceptions/branches/tseaver-no_2to3/docs/make.bat
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/docs/make.bat (rev 0)
+++ zope.exceptions/branches/tseaver-no_2to3/docs/make.bat 2012-04-06 21:19:17 UTC (rev 125038)
@@ -0,0 +1,190 @@
+ at ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\zopeexceptions.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\zopeexceptions.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
Added: zope.exceptions/branches/tseaver-no_2to3/docs/narr.rst
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/docs/narr.rst (rev 0)
+++ zope.exceptions/branches/tseaver-no_2to3/docs/narr.rst 2012-04-06 21:19:17 UTC (rev 125038)
@@ -0,0 +1,108 @@
+Using :mod:`zope.exceptions`
+============================
+
+This module extends the standard library's :mod:`traceback` module, allowing
+application code to add additional information to the formatted tracebacks
+using specially-named variables in the scope of a given frame.
+
+
+Annotating Application Code
+---------------------------
+
+:py:data:`__traceback_supplement__`
++++++++++++++++++++++++++++++++++++
+
+This variable can be defined either at either local or global scope.
+The formatting functions treat objects with this name as though they support
+the :py:class:`~zope.exceptions.interfaces.ITracebackSupplement` interface.
+The various attributes (all optional) of that interface will be used to
+add structured information to the formatted traceback.
+
+For example, assuming your code renders a template:
+
+.. doctest::
+
+ >>> import os
+ >>> class Supplement(object):
+ ... def __init__(self, template_file, source):
+ ... self.source_url = 'file://%s' % os.path.abspath(template_file)
+ ... self.source = source
+ ... def getInfo(self):
+ ... return self.source
+ >>> def render_w_supplement(template_file, options):
+ ... source = open(template_file).read()
+ ... __traceback_supplement__ = Supplement(template_file, source)
+
+Here, the filename and source of the template will be rendered as part of
+the traceback.
+
+
+:py:data:`__traceback_info__`
++++++++++++++++++++++++++++++
+
+This variable can only be defined at local scope. It will be converted to a
+string when added to the formatted traceback.
+
+.. doctest::
+
+ >>> def render_w_info(template_file, options):
+ ... source = open(template_file).read()
+ ... __traceback_info__ = '%s\n\n%s' % (template_file, source)
+
+
+API Functions
+-------------
+Three API functions support these features when formatting Python
+exceptions and their associated tracebacks:
+
+:py:func:`~zope.exceptions.exceptionformatter.format_exception`
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Use this API to format an exception and traceback as a string, using
+the special annotations. E.g.:
+
+.. doctest::
+
+ >>> import sys
+ >>> from zope.exceptions import format_exception
+ >>> try:
+ ... raise ValueError('demo')
+ ... except:
+ ... t, v, tb = sys.exc_info()
+ ... report = format_exception(t, v, tb)
+ ... del tb # avoid a leak
+ ... # Now do something with report, e.g., send e-mail.
+
+
+:py:func:`~zope.exceptions.exceptionformatter.print_exception`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Use this API to write the formated exception and traceback to a file-like
+object, using the special annotations. E.g.:
+
+.. doctest::
+
+ >>> from zope.exceptions import print_exception
+ >>> try:
+ ... raise ValueError('demo')
+ ... except:
+ ... t, v, tb = sys.exc_info()
+ ... print_exception(t, v, tb, file=sys.stderr)
+ ... del tb # avoid a leak
+
+
+:py:func:`~zope.exceptions.exceptionformatter.extract_stack`
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Use this API to format just the traceback as a list of string,s using the
+special annotations. E.g.:
+
+.. doctest::
+
+ >>> import sys
+ >>> from zope.exceptions import extract_stack
+ >>> try:
+ ... raise ValueError('demo')
+ ... except:
+ ... for line in extract_stack(sys.exc_info()[2].tb_frame):
+ ... pass # do something with each line
Modified: zope.exceptions/branches/tseaver-no_2to3/src/zope/exceptions/__init__.py
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/src/zope/exceptions/__init__.py 2012-04-06 19:50:02 UTC (rev 125037)
+++ zope.exceptions/branches/tseaver-no_2to3/src/zope/exceptions/__init__.py 2012-04-06 21:19:17 UTC (rev 125038)
@@ -16,9 +16,15 @@
These exceptions are so general purpose that they don't belong in Zope
application-specific packages.
"""
-from zope.exceptions.interfaces import DuplicationError, IDuplicationError
-from zope.exceptions.interfaces import UserError, IUserError
+from zope.exceptions.interfaces import DuplicationError
+from zope.exceptions.interfaces import IDuplicationError
+from zope.exceptions.interfaces import UserError
+from zope.exceptions.interfaces import IUserError
+from zope.exceptions.exceptionformatter import format_exception
+from zope.exceptions.exceptionformatter import print_exception
+from zope.exceptions.exceptionformatter import extract_stack
+
# avoid dependency on zope.security:
try:
import zope.security
@@ -27,6 +33,9 @@
if not str(v).endswith('security'):
raise
else: #pragma NO COVER
- from zope.security.interfaces import IUnauthorized, Unauthorized
- from zope.security.interfaces import IForbidden, IForbiddenAttribute
- from zope.security.interfaces import Forbidden, ForbiddenAttribute
+ from zope.security.interfaces import IUnauthorized
+ from zope.security.interfaces import Unauthorized
+ from zope.security.interfaces import IForbidden
+ from zope.security.interfaces import IForbiddenAttribute
+ from zope.security.interfaces import Forbidden
+ from zope.security.interfaces import ForbiddenAttribute
Modified: zope.exceptions/branches/tseaver-no_2to3/src/zope/exceptions/interfaces.py
===================================================================
--- zope.exceptions/branches/tseaver-no_2to3/src/zope/exceptions/interfaces.py 2012-04-06 19:50:02 UTC (rev 125037)
+++ zope.exceptions/branches/tseaver-no_2to3/src/zope/exceptions/interfaces.py 2012-04-06 21:19:17 UTC (rev 125038)
@@ -104,10 +104,6 @@
itself provides enough information.
""")
- def getInfo(as_html=0):
+ def getInfo():
"""Optional. Returns a string containing any other useful info.
-
- If as_html is set, the implementation must HTML-quote the result
- (normally using cgi.escape()). Returns None to provide no
- extra info.
"""
More information about the checkins
mailing list