diff --git a/.gitignore b/.gitignore index 401eb52..005ad1e 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ bin build develop-eggs parts +docs/_build/ diff --git a/CHANGES.rst b/CHANGES.rst index 1758785..9738eb1 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,7 +4,8 @@ Changes 4.0.1 (unreleased) ------------------ -- TBD +- Convert doctests to Sphinx documentation, including building docs + and running doctest snippets under ``tox``. 4.0.0 (2014-12-24) ------------------ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..4c2d034 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# 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 ' where 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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @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 " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @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/zopecatalog.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/zopecatalog.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/zopecatalog" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/zopecatalog" + @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." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @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." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..a5eb50f --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ +:mod:`zope.catalog` API +======================= + +Interfaces +---------- + +.. automodule:: zope.catalog.interfaces + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..6105d82 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,269 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# zope.catalog documentation build configuration file, created by +# sphinx-quickstart on Thu Jan 29 11:31:12 2015. +# +# 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 +import 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.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 = 'zope.catalog' +copyright = '2015, Zope Foundation and 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 = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- 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 +# " v 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# 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 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 = 'zopecatalogdoc' + + +# -- 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, or own class]). +latex_documents = [ + ('index', 'zopecatalog.tex', 'zope.catalog Documentation', + 'Zope Foundation and 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', 'zopecatalog', 'zope.catalog Documentation', + ['Zope Foundation and 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', 'zopecatalog', 'zope.catalog Documentation', + 'Zope Foundation and Contributors', 'zopecatalog', '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' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/src/zope/catalog/event.txt b/docs/events.rst similarity index 90% rename from src/zope/catalog/event.txt rename to docs/events.rst index 6bd95d6..40d62eb 100644 --- a/src/zope/catalog/event.txt +++ b/docs/events.rst @@ -1,6 +1,16 @@ Automatic indexing with events ============================== +.. testsetup:: + + from zope.catalog.tests import placefulSetUp + root = placefulSetUp() + +.. testcleanup:: + + from zope.catalog.tests import placefulTearDown + placefulTearDown() + In order to automatically keep the catalog up-to-date any objects that are added to a intid utility are indexed automatically. Also when an object gets modified it is reindexed by listening to IObjectModified @@ -9,6 +19,8 @@ events. Let us create a fake catalog to demonstrate this behaviour. We only need to implement the index_doc method for this test. +.. doctest:: + >>> from zope.catalog.interfaces import ICatalog >>> from zope import interface, component >>> @interface.implementer(ICatalog) @@ -21,6 +33,8 @@ need to implement the index_doc method for this test. We also need an intid util and a keyreference adapter. +.. doctest:: + >>> from zope.intid import IntIds >>> from zope.intid.interfaces import IIntIds >>> intids = IntIds() @@ -37,6 +51,8 @@ We also need an intid util and a keyreference adapter. We have a subscriber to IIntidAddedEvent. +.. doctest:: + >>> from zope.catalog import catalog >>> from zope.intid.interfaces import IntIdAddedEvent >>> d1 = Dummy(u'one') @@ -45,12 +61,16 @@ We have a subscriber to IIntidAddedEvent. Now we have indexed the object. +.. doctest:: + >>> cat.indexed.pop() (..., ) When an object is modified an objectmodified event should be fired by the application. Here is the handler for such an event. +.. doctest:: + >>> from zope.lifecycleevent import ObjectModifiedEvent >>> catalog.reindexDocSubscriber(ObjectModifiedEvent(d1)) >>> len(cat.indexed) @@ -66,10 +86,14 @@ example when a lot of indexes are in the catalog and only specific indexes needs to be updated. There are marker interfaces to achieve this. +.. doctest:: + >>> from zope.catalog.interfaces import INoAutoIndex If an object provides this interface it is not automatically indexed. +.. doctest:: + >>> interface.alsoProvides(d1, INoAutoIndex) >>> catalog.indexDocSubscriber(IntIdAddedEvent(d1, None)) >>> len(cat.indexed) @@ -79,6 +103,8 @@ If an object provides this interface it is not automatically indexed. If an object provides this interface it is not automatically reindexed. +.. doctest:: + >>> interface.alsoProvides(d1, INoAutoReindex) >>> catalog.reindexDocSubscriber(ObjectModifiedEvent(d1)) >>> len(cat.indexed) diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..fa0df62 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,19 @@ +:mod:`zope.catalog` +=================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + narrative + api + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..9372f64 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,242 @@ +@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 ^` where ^ 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. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + 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 +) + + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +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\zopecatalog.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\zopecatalog.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" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF 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 +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/src/zope/catalog/README.txt b/docs/narrative.rst similarity index 94% rename from src/zope/catalog/README.txt rename to docs/narrative.rst index 2ba0536..f9e8018 100644 --- a/src/zope/catalog/README.txt +++ b/docs/narrative.rst @@ -1,8 +1,23 @@ -Using Catalogs -============== +Using :mod:`zope.catalog` +========================= + +.. testsetup:: + + from zope.catalog.tests import placelessSetUp + placelessSetUp() + +.. testcleanup:: + + from zope.catalog.tests import placelessTearDown + placelessTearDown() + +Basic Usage +----------- Let's look at an example: +.. doctest:: + >>> from zope.catalog.catalog import Catalog >>> cat = Catalog() @@ -14,6 +29,8 @@ attribute value. The `catalog` package provides an attribute-index mix-in class that is meant to work with a base indexing class. First, we'll write the base index class: +.. doctest:: + >>> import persistent, BTrees.OOBTree, BTrees.IFBTree, BTrees.IOBTree >>> import zope.interface, zope.index.interfaces @@ -69,6 +86,8 @@ method. Now, we can use the AttributeIndex mixin to make this an attribute index: +.. doctest:: + >>> import zope.catalog.attribute >>> import zope.catalog.interfaces >>> import zope.container.contained @@ -88,6 +107,8 @@ constraints, we have to provide `ICatalogIndex`, which extends Now let's add some of these indexes to our catalog. Let's create some indexes. First we'll define some interfaces providing data to index: +.. doctest:: + >>> class IFavoriteColor(zope.interface.Interface): ... color = zope.interface.Attribute("Favorite color") @@ -97,6 +118,8 @@ indexes. First we'll define some interfaces providing data to index: We'll create color and age indexes: +.. doctest:: + >>> cat['color'] = Index('color', IFavoriteColor) >>> cat['age'] = Index('age', IPerson, True) >>> cat['size'] = Index('sz') @@ -117,6 +140,8 @@ present, then we'll ignore the object. Now, let's create some objects and index them: +.. doctest:: + >>> @zope.interface.implementer(IPerson) ... class Person: ... def __init__(self, age): @@ -135,7 +160,7 @@ Now, let's create some objects and index them: ... Person.__init__(self, age) >>> class Whatever: - ... def __init__(self, **kw): + ... def __init__(self, **kw): #** ... self.__dict__.update(kw) >>> o1 = Person(10) @@ -155,6 +180,8 @@ Now, let's create some objects and index them: We search by providing query mapping objects that have a key for every index we want to use: +.. doctest:: + >>> list(cat.apply({'age': 10})) [1, 6] >>> list(cat.apply({'age': 10, 'color': 'blue'})) @@ -166,12 +193,16 @@ index we want to use: We can unindex objects: +.. doctest:: + >>> cat.unindex_doc(4) >>> list(cat.apply({'size': 5})) [] and reindex objects: +.. doctest:: + >>> o5.sz = 5 >>> cat.index_doc(5, o5) >>> list(cat.apply({'size': 5})) @@ -179,6 +210,8 @@ and reindex objects: If we clear the catalog, we'll clear all of the indexes: +.. doctest:: + >>> cat.clear() >>> [len(index.forward) for index in cat.values()] [0, 0, 0] @@ -186,6 +219,8 @@ If we clear the catalog, we'll clear all of the indexes: Note that you don't have to use the catalog's search methods. You can access its indexes directly, since the catalog is a mapping: +.. doctest:: + >>> [(name, cat[name].field_name) for name in cat] [(u'age', 'age'), (u'color', 'color'), (u'size', 'sz')] @@ -193,6 +228,8 @@ Catalogs work with int-id utilities, which are responsible for maintaining id <-> object mappings. To see how this works, we'll create a utility to work with our catalog: +.. doctest:: + >>> import zope.intid.interfaces >>> @zope.interface.implementer(zope.intid.interfaces.IIntIds) ... class Ids: @@ -209,17 +246,23 @@ create a utility to work with our catalog: With this utility in place, catalogs can recompute indexes: +.. doctest:: + >>> cat.updateIndex(cat['size']) >>> list(cat.apply({'size': 5})) [4, 5] Of course, that only updates *that* index: +.. doctest:: + >>> list(cat.apply({'age': 10})) [] We can update all of the indexes: +.. doctest:: + >>> cat.updateIndexes() >>> list(cat.apply({'age': 10})) [1, 6] @@ -230,6 +273,8 @@ We can update all of the indexes: There's an alternate search interface that returns "result sets". Result sets provide access to objects, rather than object ids: +.. doctest:: + >>> result = cat.searchResults(size=5) >>> len(result) 2 @@ -242,6 +287,8 @@ results. When not using sorting, limiting and reversing are done by simple slicing and list reversing. +.. doctest:: + >>> list(cat.searchResults(size=5, _reverse=True)) == [o5, o4] True @@ -256,6 +303,8 @@ are passed to the index ``sort`` method so it can do it efficiently. Let's index more objects to work with: +.. doctest:: + >>> o7 = DiscriminatingPerson(7, 'blue') >>> o8 = DiscriminatingPerson(3, 'blue') >>> o9 = DiscriminatingPerson(14, 'blue') @@ -268,6 +317,8 @@ Let's index more objects to work with: Now we can search all people who like blue, ordered by age: +.. doctest:: + >>> results = list(cat.searchResults(color='blue', _sort_index='age')) >>> results == [o3, o10, o8, o7, o6, o9] True @@ -290,6 +341,8 @@ scores, according to how closely a document matches a query. Let's create a new index, a "keyword index" that indexes sequences of values: +.. doctest:: + >>> @zope.interface.implementer( ... zope.index.interfaces.IInjection, ... zope.index.interfaces.IIndexSearch, @@ -339,6 +392,8 @@ values: Now, we'll add a hobbies index: +.. doctest:: + >>> cat['hobbies'] = KeywordIndex('hobbies') >>> o1.hobbies = 'camping', 'music' >>> o2.hobbies = 'hacking', 'sailing' @@ -348,6 +403,8 @@ Now, we'll add a hobbies index: When we apply the catalog: +.. doctest:: + >>> cat.apply({'hobbies': ['music', 'camping', 'sailing']}) BTrees.IFBTree.IFBucket([(1, 2.0), (2, 1.0), (3, 3.0)]) @@ -355,9 +412,18 @@ We found objects 1-3, because they each contained at least some of the words in the query. The scores represent the number of words that matched. If we also include age: +.. doctest:: + >>> cat.apply({'hobbies': ['music', 'camping', 'sailing'], 'age': 10}) BTrees.IFBTree.IFBucket([(1, 3.0)]) The score increased because we used an additional index. If an index doesn't provide scores, scores of 1.0 are assumed. +Additional Topics +----------------- + +.. toctree:: + :maxdepth: 2 + + events diff --git a/setup.py b/setup.py index 0239080..1613941 100644 --- a/setup.py +++ b/setup.py @@ -32,10 +32,6 @@ def read(*rnames): long_description=( read('README.rst') + '\n\n' + - read('src', 'zope', 'catalog', 'README.txt') - + '\n\n' + - read('src', 'zope', 'catalog', 'event.txt') - + '\n\n' + read('CHANGES.rst') ), keywords = "zope3 catalog index", diff --git a/src/zope/catalog/tests.py b/src/zope/catalog/tests.py index 3910df0..800198d 100644 --- a/src/zope/catalog/tests.py +++ b/src/zope/catalog/tests.py @@ -730,19 +730,6 @@ def test_suite(): suite.addTest(unittest.makeSuite(TestCatalogBugs)) suite.addTest(unittest.makeSuite(TestIndexRaisingValueGetter)) suite.addTest(doctest.DocTestSuite('zope.catalog.attribute')) - suite.addTest(doctest.DocFileSuite( - 'README.txt', - setUp=placelessSetUp, - tearDown=placelessTearDown, - checker=checker, - )) - suite.addTest(doctest.DocFileSuite( - 'event.txt', - setUp=setUp, - tearDown=lambda x: placefulTearDown(), - optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS, - checker=checker, - )) return suite diff --git a/tox.ini b/tox.ini index 3fa701e..157eb8e 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] envlist = - py26,py27,py33,py34 + py26,py27,py33,py34,docs [testenv] commands = @@ -19,3 +19,14 @@ deps = zope.schema zope.site zope.testing + +[testenv:docs] +basepython = + python2.7 +commands = + sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html + sphinx-build -b doctest -d docs/_build/doctrees docs docs/_build/doctest +deps = + {[testenv]deps} + Sphinx + repoze.sphinx.autointerface