Merge 3214e8b into 0aa5944

.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

@@ -5,7 +5,7 @@
 4.3.1 (unreleased)
 ==================
 
-- Nothing changed yet.
+- Host documentation at https://zopepagetemplate.readthedocs.io/
 
 
 4.3.0 (2017-09-04)

MANIFEST.in

@@ -7,3 +7,9 @@ include .travis.yml
 include .coveragerc
 
 recursive-include src *.txt *.html *.pt
+
+recursive-include docs *.rst
+recursive-include docs *.py
+recursive-include docs *.pt
+recursive-include docs Makefile
+recursive-include docs *.bat

README.rst

@@ -1,6 +1,6 @@
-=======================
- ``zope.pagetemplate``
-=======================
+===================
+ zope.pagetemplate
+===================
 
 .. image:: https://img.shields.io/pypi/v/zope.pagetemplate.svg
         :target: https://pypi.python.org/pypi/zope.pagetemplate/
@@ -16,8 +16,21 @@
 .. image:: https://coveralls.io/repos/github/zopefoundation/zope.pagetemplate/badge.svg?branch=master
         :target: https://coveralls.io/github/zopefoundation/zope.pagetemplate?branch=master
 
+.. image:: https://readthedocs.org/projects/zopepagetemplate/badge/?version=latest
+        :target: https://zopepagetemplate.readthedocs.org/en/latest/
+        :alt: Documentation Status
+
 
 Page Templates provide an elegant templating mechanism that achieves a
 clean separation of presentation and application logic while allowing
 for designers to work with templates in their visual editing tools
 (FrontPage, Dreamweaver, GoLive, etc.).
+
+Page Templates are based on `a Template Attribute Language
+<https://pypi.python.org/pypi/zope.tal>`_ with expressions provided by
+`TALES <https://pypi.python.org/pypi/zope.tales>`_. For a description
+of their syntax, see `the reference documentation
+<https://docs.zope.org/zope2/zope2book/AppendixC.html>`_.
+
+For detailed documentation on the usage of this package, see
+https://zopepagetemplate.readthedocs.io

doc-requirements.txt

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

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 <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 "  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."

src/zope/pagetemplate/architecture.txt → docs/architecture.rst

@@ -1,31 +1,39 @@
-ZPT (Zope Page-Template) Architecture
-=====================================
+=======================================
+ ZPT (Zope Page-Template) Architecture
+=======================================
 
 There are a number of major components that make up the page-template
-architecture: 
+architecture:
 
 - The TAL *compiler* and *interpreter*.  This is responsible for
   compiling source files and for executing compiled templates.  See
-  the `zope.tal` package for more information.
+  the zope.tal_ package for more information.
 
 - An *expression engine* is responsible for compiling expressions and
   for creating expression execution contexts.  It is common for
   applications to override expression engines to provide custom
   expression support or to change the way expressions are implemented.
-  The `zope.app.pagetemplate` package uses this to implement trusted
+
+  The :mod:`zope.pagetemplate.engine` module uses this to implement trusted
   and untrusted evaluation; a different engine is used for each, with
   different implementations of the same type of expressions.
 
+  The z3c.ptcompat_ package extends these engines to use the
+  Chameleon_ templating system for increased speed.
+
   Expression contexts support execution of expressions and provide
   APIs for setting up variable scopes and setting variables.  The
   expression contexts are passed to the TAL interpreter at execution
   time.
-  
+
   The most commonly used expression implementation is that found in
-  `zope.tales`.
+  zope.tales_.
 
 - Page templates tie everything together. They assemble an expression
   engine with the TAL interpreter and orchestrate management of source
-  and compiled template data.  See `zope.pagetemplate.interfaces`.
+  and compiled template data.  See :mod:`zope.pagetemplate.interfaces`.
 
-
+.. _z3c.ptcompat: https://pypi.python.org/pypi/z3c.ptcompat
+.. _zope.tal: https://pypi.python.org/pypi/zope.tal
+.. _zope.tales: https://pypi.python.org/pypi/zope.tales
+.. _Chameleon: https://chameleon.readthedocs.io/en/latest/

docs/changelog.rst

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