Merge 5f94110 into 6d42afa

.gitignore

@@ -9,3 +9,4 @@ eggs/
 parts/
 .coverage
 htmlcov/
+docs/_build/

.travis.yml

@@ -6,13 +6,14 @@ python:
     - 3.5
     - 3.6
     - pypy
-    - pypy3.5-5.8.0
+    - pypy3
 install:
     - pip install -U pip setuptools
     - pip install -U coverage coveralls
-    - pip install -U -e .[test]
+    - pip install -U -e .[test,docs]
 script:
     - coverage run -m zope.testrunner --test-path=src
+    - coverage run -a -m sphinx -b doctest -d docs/_build/doctrees docs docs/_build/doctest
 after_success:
     - coveralls
 notifications:

CHANGES.rst

@@ -8,6 +8,7 @@
 - Fixed UpdateNotCalled being an instance rather than an exception class
   (https://github.com/zopefoundation/zope.contentprovider/issues/4).
 
+- Host documentation at https://zopecontentprovider.readthedocs.io
 
 4.1.0 (2017-08-08)
 ==================

MANIFEST.in

@@ -8,4 +8,7 @@ include .coveragerc
 
 recursive-include src *
 
+recursive-include docs *.rst
+recursive-include docs *.py
+
 global-exclude *.pyc

README.rst

@@ -1,6 +1,6 @@
-==========================
- ``zope.contentprovider``
-==========================
+======================
+ zope.contentprovider
+======================
 
 .. image:: https://img.shields.io/pypi/v/zope.contentprovider.svg
         :target: https://pypi.python.org/pypi/zope.contentprovider/
@@ -16,8 +16,14 @@
 .. image:: https://coveralls.io/repos/github/zopefoundation/zope.contentprovider/badge.svg?branch=master
         :target: https://coveralls.io/github/zopefoundation/zope.contentprovider?branch=master
 
+.. image:: https://readthedocs.org/projects/zopecontentprovider/badge/?version=latest
+        :target: https://zopecontentprovider.readthedocs.io/en/latest/?badge=latest
+        :alt: Documentation Status
+
 This package provides a framework to develop componentized Web GUI
 applications. Instead of describing the content of a page using a single
 template or static system of templates and METAL macros, content provider
 objects are dynamically looked up based on the setup/configuration of the
 application.
+
+Detailed documentation is available at https://zopecontentprovider.readthedocs.io

doc-requirements.txt

@@ -0,0 +1 @@
+.[docs]

docs/api_provider.rst

@@ -0,0 +1,46 @@
+=======================
+ Provided Base Classes
+=======================
+
+The `zope.contentprovider.provider` module provides an useful base
+class for implementing content providers. It has all boilerplate code
+and it's only required to override the ``render`` method to make it
+work:
+
+  >>> from zope.contentprovider import interfaces
+  >>> from zope.contentprovider.provider import ContentProviderBase
+
+  >>> class MyProvider(ContentProviderBase):
+  ...     def render(self, *args, **kwargs):
+  ...         return 'Hi there'
+
+  >>> provider = MyProvider(None, None, None)
+  >>> interfaces.IContentProvider.providedBy(provider)
+  True
+
+  >>> provider.update()
+  >>> print(provider.render())
+  Hi there
+
+Note that it can't be used as is, without providing the ``render`` method:
+
+  >>> bad = ContentProviderBase(None, None, None)
+  >>> bad.update()
+  >>> print(bad.render())
+  Traceback (most recent call last):
+  ...
+  NotImplementedError: ``render`` method must be implemented by subclass
+
+You can add the update logic into the ``update`` method as with any content
+provider and you can implement more complex rendering patterns, based on
+templates, using this ContentProviderBase class as a base.
+
+You might also want to look at the `zope.viewlet`_ package for a more
+featureful API.
+
+.. _zope.viewlet: https://zopeviewlet.readthedocs.io
+
+zope.contentprovider.provider
+=============================
+
+.. automodule:: zope.contentprovider.provider

docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGES.rst

docs/conf.py

@@ -0,0 +1,284 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# zope.contentprovider 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
+import pkg_resources
+sys.path.append(os.path.abspath('../src'))
+rqmt = pkg_resources.require('zope.contentprovider')[0]
+
+# 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.contentprovider'
+copyright = '2015-2017, 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 = '%s.%s' % tuple(map(int, rqmt.version.split('.')[:2]))
+# The full version, including alpha/beta/rc tags.
+release = rqmt.version
+
+# 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 = 'obj'
+
+# 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
+# "<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']
+
+# 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 <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 = 'zopecontentproviderdoc'
+
+
+# -- 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', 'zopecontentprovider.tex', 'zope.contentprovider 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', 'zopecontentprovider', 'zope.contentprovider 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', 'zopecontentprovider', 'zope.contentprovider Documentation',
+   'Zope Foundation and Contributors', 'zopecontentprovider', '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 = {
+    'https://docs.python.org/': None,
+    'https://zopeinterface.readthedocs.io/en/latest/': None,
+    'https://zopeviewlet.readthedocs.io/en/latest/': None,
+    'https://zopelocation.readthedocs.io/en/latest/': None,
+    'https://zopetales.readthedocs.io/en/latest/': None,
+    'https://zopebrowser.readthedocs.io/en/latest/': None,
+    'https://zopepublisher.readthedocs.io/en/latest/': None,
+}
+
+autodoc_default_flags = ['members', 'show-inheritance']
+autoclass_content = 'both'
+autodoc_member_order = 'bysource'