Merge branch 'master' into pr/2853

Pylons · Dec 14, 2016 · 12a11da · 12a11da
2 parents 3c5731a + 8dfa640
commit 12a11da
Show file tree

Hide file tree

Showing 41 changed files with 2,027 additions and 193 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -122,6 +122,16 @@ Features
 
   See https://github.com/Pylons/pyramid/pull/2805
 
+- A new ``[pserve]`` section is supported in your config files with a
+  ``watch_files`` key that can configure ``pserve --reload`` to monitor custom
+  file paths. See https://github.com/Pylons/pyramid/pull/2827
+
+- Allow streaming responses to be made from subclasses of
+  ``pyramid.httpexceptions.HTTPException``. Previously the response would
+  be unrolled while testing for a body, making it impossible to stream
+  a response.
+  See https://github.com/Pylons/pyramid/pull/2863
+
 Bug Fixes
 ---------
 
@@ -152,11 +162,18 @@ Bug Fixes
   from previous orders have executed.
   See https://github.com/Pylons/pyramid/pull/2757
 
+- Fix bug in i18n where the default domain would always use the Germanic plural
+  style, even if a different plural function is defined in the relevant
+  messages file. See https://github.com/Pylons/pyramid/pull/2859
+
 Deprecations
 ------------
 
 Documentation Changes
 ---------------------
+- Replace Typographical Conventions with an enhanced Style Guide.
+  https://github.com/Pylons/pyramid/pull/2838
+
 - Add pyramid_nacl_session to session factories.
   See https://github.com/Pylons/pyramid/issues/2791
 

diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -285,6 +285,8 @@ Contributors
 
 - Keith Yang, 2016/07/22
 
+- Hannah Krager, 2016/10/22
+
 - Moriyoshi Koizumi, 2016/11/20
 
 - Mikko Ohtamaa, 2016/12/6

diff --git a/docs/api/i18n.rst b/docs/api/i18n.rst
@@ -6,6 +6,7 @@
 .. automodule:: pyramid.i18n
 
   .. autoclass:: TranslationString
+     :noindex:
 
   .. autofunction:: TranslationStringFactory
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -51,9 +51,10 @@ def nothing(*arg):
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
-    'repoze.sphinx.autointerface',
-    'sphinx.ext.viewcode',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+    'repoze.sphinx.autointerface',
     'sphinxcontrib.programoutput',
     # enable pylons_sphinx_latesturl when this branch is no longer "latest"
     # 'pylons_sphinx_latesturl',
@@ -68,6 +69,7 @@ def nothing(*arg):
     'pylonswebframework': ('http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/', None),
     'python': ('https://docs.python.org/3', None),
     'pytest': ('http://pytest.org/latest/', None),
+    'sphinx': ('http://www.sphinx-doc.org/en/latest', None),
     'sqla': ('http://docs.sqlalchemy.org/en/latest', None),
     'tm': ('http://docs.pylonsproject.org/projects/pyramid-tm/en/latest/', None),
     'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None),
@@ -119,6 +121,9 @@ def nothing(*arg):
 # unit titles (such as .. function::).
 add_module_names = False
 
+# Add support for todo items
+todo_include_todos = True
+
 # The name of the Pygments (syntax highlighting) style to use.
 #pygments_style = book and 'bw' or 'tango'
 if book:

diff --git a/docs/conventions.rst b/docs/conventions.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -213,13 +213,14 @@ Copyright, Trademarks, and Attributions
    copyright
 
 
-Typographical Conventions
-=========================
+Typographical Conventions and Style Guide
+=========================================
 
 .. toctree::
    :maxdepth: 1
 
-   conventions
+   typographical-conventions
+   style-guide
 
 
 Index and Glossary

diff --git a/docs/latexindex.rst b/docs/latexindex.rst
@@ -15,7 +15,7 @@ Front Matter
    :maxdepth: 1
 
    copyright
-   conventions
+   style-guide
    authorintro
    designdefense
 

diff --git a/docs/narr/project.rst b/docs/narr/project.rst
@@ -1067,3 +1067,25 @@ hard drive, you should install the
 `watchdog <http://pythonhosted.org/watchdog/>` package in development.
 ``hupper`` will automatically use ``watchdog`` to more efficiently poll the
 filesystem.
+
+Monitoring Custom Files
+~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, ``pserve --reload`` will monitor all imported Python code
+(everything in ``sys.modules``) as well as the config file passed to
+``pserve`` (e.g. ``development.ini``). You can instruct ``pserve`` to watch
+other files for changes as well by defining a ``[pserve]`` section in your
+configuration file. For example, let's say your application loads the
+``favicon.ico`` file at startup and stores it in memory to efficiently
+serve it many times. When you change it you want ``pserve`` to restart:
+
+.. code-block:: ini
+
+    [pserve]
+    watch_files =
+        myapp/static/favicon.ico
+
+Paths may be absolute or relative to the configuration file. They may also
+be an :term:`asset specification`. These paths are passed to ``hupper`` which
+has some basic support for globbing. Acceptable glob patterns depend on the
+version of Python being used.