From 6f31f1c51c531029a998f707b36a28ee6be43171 Mon Sep 17 00:00:00 2001 From: Joel Rivera Date: Mon, 14 May 2018 10:32:09 -0500 Subject: Removes the step to install additional packages in the quick tutorial. This part is redundant because in the same tutorial we indicate to install the application in development/editable mode with `pip -e` in the next section. (which will install the required dependencies if needed by the app) Related issue: #3181 --- docs/quick_tutorial/requirements.rst | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst index a65cfe6d2..6bb12c984 100644 --- a/docs/quick_tutorial/requirements.rst +++ b/docs/quick_tutorial/requirements.rst @@ -202,17 +202,3 @@ part is pretty easy. We'll also install a WSGI server, Waitress. Our Python virtual environment now has the Pyramid software available as well as the ``waitress`` package. -You can optionally install some of the extra Python packages used in this -tutorial. - -.. code-block:: bash - - # Mac and Linux - $ $VENV/bin/pip install webtest pytest pytest-cov deform sqlalchemy \ - pyramid_chameleon pyramid_debugtoolbar pyramid_jinja2 waitress \ - pyramid_tm zope.sqlalchemy - -.. code-block:: doscon - - # Windows - c:\> %VENV%\Scripts\pip install webtest pytest pytest-cov deform sqlalchemy pyramid_chameleon pyramid_debugtoolbar pyramid_jinja2 waitress pyramid_tm zope.sqlalchemy -- cgit v1.2.3 From e68e308330bd1626518c695d3253f9db828f4669 Mon Sep 17 00:00:00 2001 From: Radu Revutchi Date: Mon, 14 May 2018 11:34:12 -0400 Subject: fixed issue #3182 - alphabetized dependencies in quick tutorial and aligned emphasize-lines --- docs/quick_tutorial/authentication.rst | 4 ++-- docs/quick_tutorial/authentication/setup.py | 7 ++++--- docs/quick_tutorial/authorization/setup.py | 7 ++++--- docs/quick_tutorial/cookiecutters/setup.py | 2 +- docs/quick_tutorial/databases/setup.py | 10 +++++----- docs/quick_tutorial/forms.rst | 2 +- docs/quick_tutorial/forms/setup.py | 6 +++--- docs/quick_tutorial/json/setup.py | 5 +++-- docs/quick_tutorial/logging/setup.py | 5 +++-- docs/quick_tutorial/more_view_classes/setup.py | 5 +++-- docs/quick_tutorial/retail_forms/setup.py | 7 ++++--- docs/quick_tutorial/routing/setup.py | 5 +++-- docs/quick_tutorial/sessions/setup.py | 5 +++-- docs/quick_tutorial/static_assets/setup.py | 5 +++-- docs/quick_tutorial/templating/setup.py | 3 ++- docs/quick_tutorial/view_classes/setup.py | 5 +++-- 16 files changed, 47 insertions(+), 36 deletions(-) (limited to 'docs') diff --git a/docs/quick_tutorial/authentication.rst b/docs/quick_tutorial/authentication.rst index 95acc33e4..529f51ddd 100644 --- a/docs/quick_tutorial/authentication.rst +++ b/docs/quick_tutorial/authentication.rst @@ -39,7 +39,7 @@ Steps .. literalinclude:: authentication/setup.py :language: python - :emphasize-lines: 7 + :emphasize-lines: 4 :linenos: #. We can now install our project in development mode: @@ -94,7 +94,7 @@ Steps #. Click the "Log In" link. -#. Submit the login form with the username ``editor`` and the password +#. Submit the login form with the username ``editor`` and the password ``editor``. #. Note that the "Log In" link has changed to "Logout". diff --git a/docs/quick_tutorial/authentication/setup.py b/docs/quick_tutorial/authentication/setup.py index 808a6f9a9..e89b4e241 100644 --- a/docs/quick_tutorial/authentication/setup.py +++ b/docs/quick_tutorial/authentication/setup.py @@ -1,10 +1,11 @@ from setuptools import setup requires = [ + 'bcrypt', 'pyramid', - 'waitress', 'pyramid_chameleon', - 'bcrypt' + 'waitress', + ] setup(name='tutorial', @@ -13,4 +14,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/authorization/setup.py b/docs/quick_tutorial/authorization/setup.py index 808a6f9a9..e89b4e241 100644 --- a/docs/quick_tutorial/authorization/setup.py +++ b/docs/quick_tutorial/authorization/setup.py @@ -1,10 +1,11 @@ from setuptools import setup requires = [ + 'bcrypt', 'pyramid', - 'waitress', 'pyramid_chameleon', - 'bcrypt' + 'waitress', + ] setup(name='tutorial', @@ -13,4 +14,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/cookiecutters/setup.py b/docs/quick_tutorial/cookiecutters/setup.py index e47cdf8ea..0d1b3f70e 100644 --- a/docs/quick_tutorial/cookiecutters/setup.py +++ b/docs/quick_tutorial/cookiecutters/setup.py @@ -10,8 +10,8 @@ with open(os.path.join(here, 'CHANGES.txt')) as f: requires = [ 'pyramid', - 'pyramid_jinja2', 'pyramid_debugtoolbar', + 'pyramid_jinja2', 'waitress', ] diff --git a/docs/quick_tutorial/databases/setup.py b/docs/quick_tutorial/databases/setup.py index 66045fd7e..13d1d6637 100644 --- a/docs/quick_tutorial/databases/setup.py +++ b/docs/quick_tutorial/databases/setup.py @@ -1,13 +1,13 @@ from setuptools import setup requires = [ + 'deform', 'pyramid', - 'waitress', 'pyramid_chameleon', - 'deform', - 'sqlalchemy', 'pyramid_tm', - 'zope.sqlalchemy' + 'sqlalchemy', + 'waitress', + 'zope.sqlalchemy', ] setup(name='tutorial', @@ -18,4 +18,4 @@ setup(name='tutorial', [console_scripts] initialize_tutorial_db = tutorial.initialize_db:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/forms.rst b/docs/quick_tutorial/forms.rst index 3c865ad09..45eb05a8f 100644 --- a/docs/quick_tutorial/forms.rst +++ b/docs/quick_tutorial/forms.rst @@ -41,7 +41,7 @@ Steps pulls in Colander as a dependency: .. literalinclude:: forms/setup.py - :emphasize-lines: 7 + :emphasize-lines: 4 :linenos: #. We can now install our project in development mode: diff --git a/docs/quick_tutorial/forms/setup.py b/docs/quick_tutorial/forms/setup.py index 5293ef7f0..968889e74 100644 --- a/docs/quick_tutorial/forms/setup.py +++ b/docs/quick_tutorial/forms/setup.py @@ -1,10 +1,10 @@ from setuptools import setup requires = [ + 'deform', 'pyramid', - 'waitress', 'pyramid_chameleon', - 'deform' + 'waitress', ] setup(name='tutorial', @@ -13,4 +13,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/json/setup.py b/docs/quick_tutorial/json/setup.py index aefa352d4..1699d9b1e 100644 --- a/docs/quick_tutorial/json/setup.py +++ b/docs/quick_tutorial/json/setup.py @@ -2,8 +2,9 @@ from setuptools import setup requires = [ 'pyramid', + 'pyramid_chameleon', 'waitress', - 'pyramid_chameleon' + ] setup(name='tutorial', @@ -12,4 +13,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/logging/setup.py b/docs/quick_tutorial/logging/setup.py index aefa352d4..1699d9b1e 100644 --- a/docs/quick_tutorial/logging/setup.py +++ b/docs/quick_tutorial/logging/setup.py @@ -2,8 +2,9 @@ from setuptools import setup requires = [ 'pyramid', + 'pyramid_chameleon', 'waitress', - 'pyramid_chameleon' + ] setup(name='tutorial', @@ -12,4 +13,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/more_view_classes/setup.py b/docs/quick_tutorial/more_view_classes/setup.py index aefa352d4..1699d9b1e 100644 --- a/docs/quick_tutorial/more_view_classes/setup.py +++ b/docs/quick_tutorial/more_view_classes/setup.py @@ -2,8 +2,9 @@ from setuptools import setup requires = [ 'pyramid', + 'pyramid_chameleon', 'waitress', - 'pyramid_chameleon' + ] setup(name='tutorial', @@ -12,4 +13,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/retail_forms/setup.py b/docs/quick_tutorial/retail_forms/setup.py index 5293ef7f0..f64049792 100644 --- a/docs/quick_tutorial/retail_forms/setup.py +++ b/docs/quick_tutorial/retail_forms/setup.py @@ -1,10 +1,11 @@ from setuptools import setup requires = [ + 'deform', 'pyramid', - 'waitress', 'pyramid_chameleon', - 'deform' + 'waitress', + ] setup(name='tutorial', @@ -13,4 +14,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/routing/setup.py b/docs/quick_tutorial/routing/setup.py index aefa352d4..1699d9b1e 100644 --- a/docs/quick_tutorial/routing/setup.py +++ b/docs/quick_tutorial/routing/setup.py @@ -2,8 +2,9 @@ from setuptools import setup requires = [ 'pyramid', + 'pyramid_chameleon', 'waitress', - 'pyramid_chameleon' + ] setup(name='tutorial', @@ -12,4 +13,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/sessions/setup.py b/docs/quick_tutorial/sessions/setup.py index aefa352d4..1699d9b1e 100644 --- a/docs/quick_tutorial/sessions/setup.py +++ b/docs/quick_tutorial/sessions/setup.py @@ -2,8 +2,9 @@ from setuptools import setup requires = [ 'pyramid', + 'pyramid_chameleon', 'waitress', - 'pyramid_chameleon' + ] setup(name='tutorial', @@ -12,4 +13,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/static_assets/setup.py b/docs/quick_tutorial/static_assets/setup.py index aefa352d4..1699d9b1e 100644 --- a/docs/quick_tutorial/static_assets/setup.py +++ b/docs/quick_tutorial/static_assets/setup.py @@ -2,8 +2,9 @@ from setuptools import setup requires = [ 'pyramid', + 'pyramid_chameleon', 'waitress', - 'pyramid_chameleon' + ] setup(name='tutorial', @@ -12,4 +13,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) diff --git a/docs/quick_tutorial/templating/setup.py b/docs/quick_tutorial/templating/setup.py index d1910178e..1699d9b1e 100644 --- a/docs/quick_tutorial/templating/setup.py +++ b/docs/quick_tutorial/templating/setup.py @@ -2,8 +2,9 @@ from setuptools import setup requires = [ 'pyramid', - 'waitress', 'pyramid_chameleon', + 'waitress', + ] setup(name='tutorial', diff --git a/docs/quick_tutorial/view_classes/setup.py b/docs/quick_tutorial/view_classes/setup.py index aefa352d4..1699d9b1e 100644 --- a/docs/quick_tutorial/view_classes/setup.py +++ b/docs/quick_tutorial/view_classes/setup.py @@ -2,8 +2,9 @@ from setuptools import setup requires = [ 'pyramid', + 'pyramid_chameleon', 'waitress', - 'pyramid_chameleon' + ] setup(name='tutorial', @@ -12,4 +13,4 @@ setup(name='tutorial', [paste.app_factory] main = tutorial:main """, -) \ No newline at end of file +) -- cgit v1.2.3 From 4d7625e9b69ba7218ad0ec79f25ce3769b199f54 Mon Sep 17 00:00:00 2001 From: LuisCastilloH Date: Tue, 15 May 2018 09:43:46 -0500 Subject: Add cut and paste text to quick tutorial index --- docs/quick_tutorial/index.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/quick_tutorial/index.rst b/docs/quick_tutorial/index.rst index b5b7b3313..f9eaee5ab 100644 --- a/docs/quick_tutorial/index.rst +++ b/docs/quick_tutorial/index.rst @@ -11,6 +11,10 @@ This hands-on tutorial covers "a little about a lot": practical introductions to the most common facilities. Fun, fast-paced, and most certainly not aimed at experts of the Pyramid web framework. +For cut and paste purposes, the source code for all stages of this tutorial can +be browsed on `GitHub `_, +which corresponds to the same location if you have Pyramid sources. + Contents ======== -- cgit v1.2.3 From efd61eb501a29970a3728a026ad0400eaff7e52d Mon Sep 17 00:00:00 2001 From: Hunter Senft-Grupp Date: Mon, 14 May 2018 17:13:30 -0400 Subject: Add Configurator context manager 'route_prefix_context' to allow for adding routes and including configuration callables with a particular route prefix. --- docs/narr/urldispatch.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'docs') diff --git a/docs/narr/urldispatch.rst b/docs/narr/urldispatch.rst index 9ac01e24a..00c7bd3bf 100644 --- a/docs/narr/urldispatch.rst +++ b/docs/narr/urldispatch.rst @@ -1045,6 +1045,24 @@ may be added in the future. For example: config = Configurator() config.include(users_include, route_prefix='/users') +A convenience context manager exists to set the route prefix for any +:meth:`pyramid.config.Configurator.add_route` or +:meth:`pyramid.config.Configurator.include` calls within the context. + +.. code-block:: python + :linenos: + + from pyramid.config import Configurator + + def timing_include(config): + config.add_route('timing.show_times', '/times') + + def main(global_config, **settings) + config = Configurator() + with config.route_prefix_context('/timing'): + config.include(timing_include) + config.add_route('timing.average', '/average') + .. index:: single: route predicates (custom) -- cgit v1.2.3 From c0f5f071b4d8672996b006d1ea38b870bfea1e11 Mon Sep 17 00:00:00 2001 From: LuisCastilloH Date: Tue, 15 May 2018 15:39:43 -0500 Subject: Removed for code review --- docs/quick_tutorial/index.rst | 4 ---- 1 file changed, 4 deletions(-) (limited to 'docs') diff --git a/docs/quick_tutorial/index.rst b/docs/quick_tutorial/index.rst index f9eaee5ab..b5b7b3313 100644 --- a/docs/quick_tutorial/index.rst +++ b/docs/quick_tutorial/index.rst @@ -11,10 +11,6 @@ This hands-on tutorial covers "a little about a lot": practical introductions to the most common facilities. Fun, fast-paced, and most certainly not aimed at experts of the Pyramid web framework. -For cut and paste purposes, the source code for all stages of this tutorial can -be browsed on `GitHub `_, -which corresponds to the same location if you have Pyramid sources. - Contents ======== -- cgit v1.2.3 From a3b215947627a6c420a5e1cd12f7bfb23379d831 Mon Sep 17 00:00:00 2001 From: LuisCastilloH Date: Tue, 15 May 2018 15:42:28 -0500 Subject: Added cut and paste instructions in new location --- docs/quick_tutorial/tutorial_approach.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst index 8da9f71b3..b76b1be40 100644 --- a/docs/quick_tutorial/tutorial_approach.rst +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -15,7 +15,7 @@ This "Getting Started" tutorial is broken into independent steps, starting with the smallest possible "single file WSGI app" example. Each of these steps introduces a topic and a very small set of concepts via working code. The steps each correspond to a directory in our workspace, where each step's directory is -a Python package. +a Python package. Source code used in this tutorial is located in the `Pyramid repository in the directory "docs/quick_tutorial" `_. You may ``git clone`` the repository, download, or copy-paste the source code. If you do so, then make sure you use the same branch as this documentation. As we develop our tutorial, our directory tree will resemble the structure below: -- cgit v1.2.3 From fe0de812873926ef3d9a36febf207c3dec8582f1 Mon Sep 17 00:00:00 2001 From: LuisCastilloH Date: Tue, 15 May 2018 15:50:14 -0500 Subject: Update quick tour index with cut and paste instructions --- docs/quick_tour.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst index c6e696ae3..a29a6ea9b 100644 --- a/docs/quick_tour.rst +++ b/docs/quick_tour.rst @@ -10,6 +10,7 @@ for those who want to evaluate Pyramid, whether you are new to Python web frameworks, or a pro in a hurry. For more detailed treatment of each topic, give the :ref:`quick_tutorial` a try. +If you would prefer to cut and paste the example code in this tour you may browsethe source code on `GitHub `. If you have downloaded the source code, you will find the tour in the same location. Installation ============ -- cgit v1.2.3 From 71cc19fcc2cf9fe5353c4c8682088d953b37c6ae Mon Sep 17 00:00:00 2001 From: LuisCastilloH Date: Tue, 15 May 2018 15:53:00 -0500 Subject: Update wiki2 tutorial index with cut and paste instructions --- docs/tutorials/wiki2/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/tutorials/wiki2/index.rst b/docs/tutorials/wiki2/index.rst index 740a7f014..32d2ad0c3 100644 --- a/docs/tutorials/wiki2/index.rst +++ b/docs/tutorials/wiki2/index.rst @@ -8,7 +8,7 @@ This tutorial introduces an :term:`SQLAlchemy` and :term:`URL dispatch`-based application with authentication and authorization. For cut and paste purposes, the source code for all stages of this tutorial can -be browsed on `GitHub `_, +be browsed on `GitHub `_, which corresponds to the same location if you have Pyramid sources. .. toctree:: -- cgit v1.2.3 From f7e065a7831439fcf35f0bedbb5f7081d0a5ee9b Mon Sep 17 00:00:00 2001 From: LuisCastilloH Date: Tue, 15 May 2018 15:55:56 -0500 Subject: Update wiki tutorial index with cut and paste instructions --- docs/tutorials/wiki/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/tutorials/wiki/index.rst b/docs/tutorials/wiki/index.rst index 7bd58656b..4c107a364 100644 --- a/docs/tutorials/wiki/index.rst +++ b/docs/tutorials/wiki/index.rst @@ -10,7 +10,7 @@ finished, the developer will have created a basic Wiki application with authentication. For cut and paste purposes, the source code for all stages of this -tutorial can be browsed on GitHub at `GitHub `_ for a specific branch or version under ``docs/tutorials/wiki/src``, +tutorial can be browsed on GitHub at `GitHub `_ for a specific branch or version under ``docs/tutorials/wiki/src``, which corresponds to the same location if you have Pyramid sources. .. toctree:: -- cgit v1.2.3 From d71bbc6358e1bc5a84a2d9ab637bdf32d027431c Mon Sep 17 00:00:00 2001 From: LuisCastilloH Date: Tue, 15 May 2018 16:08:10 -0500 Subject: Fix misspelling --- docs/quick_tour.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst index a29a6ea9b..6d31cdc4e 100644 --- a/docs/quick_tour.rst +++ b/docs/quick_tour.rst @@ -10,7 +10,7 @@ for those who want to evaluate Pyramid, whether you are new to Python web frameworks, or a pro in a hurry. For more detailed treatment of each topic, give the :ref:`quick_tutorial` a try. -If you would prefer to cut and paste the example code in this tour you may browsethe source code on `GitHub `. If you have downloaded the source code, you will find the tour in the same location. +If you would prefer to cut and paste the example code in this tour you may browse the source code on `GitHub `. If you have downloaded the source code, you will find the tour in the same location. Installation ============ -- cgit v1.2.3 From 21ea2cb9e6dbb509ba275f9d4cbad6258a9c3c51 Mon Sep 17 00:00:00 2001 From: Radu Revutchi Date: Tue, 15 May 2018 18:08:19 -0400 Subject: issue #3182 removed extra lines from previous PR --- docs/quick_tutorial/authentication/setup.py | 1 - docs/quick_tutorial/authorization/setup.py | 1 - docs/quick_tutorial/json/setup.py | 1 - docs/quick_tutorial/logging/setup.py | 1 - docs/quick_tutorial/more_view_classes/setup.py | 1 - docs/quick_tutorial/retail_forms/setup.py | 1 - docs/quick_tutorial/routing/setup.py | 1 - docs/quick_tutorial/sessions/setup.py | 1 - docs/quick_tutorial/static_assets/setup.py | 1 - docs/quick_tutorial/templating/setup.py | 1 - docs/quick_tutorial/view_classes/setup.py | 1 - 11 files changed, 11 deletions(-) (limited to 'docs') diff --git a/docs/quick_tutorial/authentication/setup.py b/docs/quick_tutorial/authentication/setup.py index e89b4e241..a5117af5a 100644 --- a/docs/quick_tutorial/authentication/setup.py +++ b/docs/quick_tutorial/authentication/setup.py @@ -5,7 +5,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/authorization/setup.py b/docs/quick_tutorial/authorization/setup.py index e89b4e241..a5117af5a 100644 --- a/docs/quick_tutorial/authorization/setup.py +++ b/docs/quick_tutorial/authorization/setup.py @@ -5,7 +5,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/json/setup.py b/docs/quick_tutorial/json/setup.py index 1699d9b1e..744612371 100644 --- a/docs/quick_tutorial/json/setup.py +++ b/docs/quick_tutorial/json/setup.py @@ -4,7 +4,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/logging/setup.py b/docs/quick_tutorial/logging/setup.py index 1699d9b1e..744612371 100644 --- a/docs/quick_tutorial/logging/setup.py +++ b/docs/quick_tutorial/logging/setup.py @@ -4,7 +4,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/more_view_classes/setup.py b/docs/quick_tutorial/more_view_classes/setup.py index 1699d9b1e..744612371 100644 --- a/docs/quick_tutorial/more_view_classes/setup.py +++ b/docs/quick_tutorial/more_view_classes/setup.py @@ -4,7 +4,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/retail_forms/setup.py b/docs/quick_tutorial/retail_forms/setup.py index f64049792..968889e74 100644 --- a/docs/quick_tutorial/retail_forms/setup.py +++ b/docs/quick_tutorial/retail_forms/setup.py @@ -5,7 +5,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/routing/setup.py b/docs/quick_tutorial/routing/setup.py index 1699d9b1e..744612371 100644 --- a/docs/quick_tutorial/routing/setup.py +++ b/docs/quick_tutorial/routing/setup.py @@ -4,7 +4,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/sessions/setup.py b/docs/quick_tutorial/sessions/setup.py index 1699d9b1e..744612371 100644 --- a/docs/quick_tutorial/sessions/setup.py +++ b/docs/quick_tutorial/sessions/setup.py @@ -4,7 +4,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/static_assets/setup.py b/docs/quick_tutorial/static_assets/setup.py index 1699d9b1e..744612371 100644 --- a/docs/quick_tutorial/static_assets/setup.py +++ b/docs/quick_tutorial/static_assets/setup.py @@ -4,7 +4,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/templating/setup.py b/docs/quick_tutorial/templating/setup.py index 1699d9b1e..744612371 100644 --- a/docs/quick_tutorial/templating/setup.py +++ b/docs/quick_tutorial/templating/setup.py @@ -4,7 +4,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', diff --git a/docs/quick_tutorial/view_classes/setup.py b/docs/quick_tutorial/view_classes/setup.py index 1699d9b1e..744612371 100644 --- a/docs/quick_tutorial/view_classes/setup.py +++ b/docs/quick_tutorial/view_classes/setup.py @@ -4,7 +4,6 @@ requires = [ 'pyramid', 'pyramid_chameleon', 'waitress', - ] setup(name='tutorial', -- cgit v1.2.3 From e6581faba90297aec9e41293be8c181f89e6816d Mon Sep 17 00:00:00 2001 From: LuisCastilloH Date: Wed, 16 May 2018 10:14:04 -0500 Subject: Update GitHub URLs for tutorials --- docs/quick_tour.rst | 2 +- docs/quick_tutorial/tutorial_approach.rst | 2 +- docs/tutorials/wiki/index.rst | 2 +- docs/tutorials/wiki2/index.rst | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst index 6d31cdc4e..97dda98c0 100644 --- a/docs/quick_tour.rst +++ b/docs/quick_tour.rst @@ -10,7 +10,7 @@ for those who want to evaluate Pyramid, whether you are new to Python web frameworks, or a pro in a hurry. For more detailed treatment of each topic, give the :ref:`quick_tutorial` a try. -If you would prefer to cut and paste the example code in this tour you may browse the source code on `GitHub `. If you have downloaded the source code, you will find the tour in the same location. +If you would prefer to cut and paste the example code in this tour you may browse the source code located in the `Pyramid repository in the directory "docs/quick_tour" `. If you have downloaded the source code, you will find the tour in the same location. Installation ============ diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst index b76b1be40..7d87b6a49 100644 --- a/docs/quick_tutorial/tutorial_approach.rst +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -15,7 +15,7 @@ This "Getting Started" tutorial is broken into independent steps, starting with the smallest possible "single file WSGI app" example. Each of these steps introduces a topic and a very small set of concepts via working code. The steps each correspond to a directory in our workspace, where each step's directory is -a Python package. Source code used in this tutorial is located in the `Pyramid repository in the directory "docs/quick_tutorial" `_. You may ``git clone`` the repository, download, or copy-paste the source code. If you do so, then make sure you use the same branch as this documentation. +a Python package. Source code used in this tutorial is located in the `Pyramid repository in the directory "docs/quick_tutorial" `_. You may ``git clone`` the repository, download, or copy-paste the source code. If you do so, then make sure you use the same branch as this documentation. As we develop our tutorial, our directory tree will resemble the structure below: diff --git a/docs/tutorials/wiki/index.rst b/docs/tutorials/wiki/index.rst index 4c107a364..7bd58656b 100644 --- a/docs/tutorials/wiki/index.rst +++ b/docs/tutorials/wiki/index.rst @@ -10,7 +10,7 @@ finished, the developer will have created a basic Wiki application with authentication. For cut and paste purposes, the source code for all stages of this -tutorial can be browsed on GitHub at `GitHub `_ for a specific branch or version under ``docs/tutorials/wiki/src``, +tutorial can be browsed on GitHub at `GitHub `_ for a specific branch or version under ``docs/tutorials/wiki/src``, which corresponds to the same location if you have Pyramid sources. .. toctree:: diff --git a/docs/tutorials/wiki2/index.rst b/docs/tutorials/wiki2/index.rst index 32d2ad0c3..40a194155 100644 --- a/docs/tutorials/wiki2/index.rst +++ b/docs/tutorials/wiki2/index.rst @@ -7,8 +7,8 @@ This tutorial introduces an :term:`SQLAlchemy` and :term:`URL dispatch`-based :app:`Pyramid` application to a developer familiar with Python. When finished, the developer will have created a basic wiki application with authentication and authorization. -For cut and paste purposes, the source code for all stages of this tutorial can -be browsed on `GitHub `_, +For cut and paste purposes, the source code for all stages of this +tutorial can be browsed on GitHub at `GitHub `_ for a specific branch or version under ``docs/tutorials/wiki2/src``, which corresponds to the same location if you have Pyramid sources. .. toctree:: -- cgit v1.2.3 From bf08a77be16b6d76390db38e233bd0f69b247c24 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 24 Apr 2018 14:03:12 -0400 Subject: make pdf rendering work again, less than optimally; take into account new sphinx latex styling, and comment out sections that just dont work now; todo and danger directives are ununsed, so ditch them Signed-off-by: Bert JW Regeer --- docs/conf.py | 78 ++++++++++++++++++++++---------------- docs/typographical-conventions.rst | 24 ------------ 2 files changed, 46 insertions(+), 56 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index cf92e05e8..5d68a73a3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -190,7 +190,10 @@ latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). latex_font_size = '10pt' -latex_additional_files = ['_static/latex-note.png', '_static/latex-warning.png'] +latex_additional_files = [ + '_static/latex-note.png', + '_static/latex-warning.png', +] # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). @@ -276,28 +279,30 @@ _PREAMBLE = r""" \definecolor{VerbatimColor}{rgb}{1,1,1} \definecolor{VerbatimBorderColor}{rgb}{1,1,1} -\makeatletter -\renewcommand{\py@noticestart@warning}{\py@heavybox} -\renewcommand{\py@noticeend@warning}{\py@endheavybox} -\renewcommand{\py@noticestart@note}{\py@heavybox} -\renewcommand{\py@noticeend@note}{\py@endheavybox} -\makeatother +% mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) +% \makeatletter +% \renewcommand{\py@noticestart@warning}{\py@heavybox} +% \renewcommand{\py@noticeend@warning}{\py@endheavybox} +% \renewcommand{\py@noticestart@note}{\py@heavybox} +% \renewcommand{\py@noticeend@note}{\py@endheavybox} +% \makeatother % icons in note and warning boxes \usepackage{ifthen} -% Keep a copy of the original notice environment -\let\origbeginnotice\notice -\let\origendnotice\endnotice -% Redefine the notice environment so we can add our own code to it -\renewenvironment{notice}[2]{% - \origbeginnotice{#1}{}% equivalent to original \begin{notice}{#1}{#2} +% Keep a copy of the original sphinxadmonition environment +\let\origbeginadmon\sphinxadmonition +\let\origendadmon\endsphinxadmonition + +% Redefine the sphinxadmonition environment so we can add our own code to it +\renewenvironment{sphinxadmonition}[2]{% + \origbeginadmon{#1}{}% equivalent to original \begin{sphinxadmonition}{#1}{#2} % load graphics \ifthenelse{\equal{#1}{warning}}{\includegraphics{latex-warning.png}}{} \ifthenelse{\equal{#1}{note}}{\includegraphics{latex-note.png}}{} % etc. -}{% - \origendnotice% equivalent to original \end{notice} + }{% +\origendadmon % equivalent to original \end{sphinxadmonition} } % try to prevent code-block boxes from splitting across pages @@ -318,7 +323,8 @@ _PREAMBLE = r""" latex_elements = { 'preamble': _PREAMBLE, - 'wrapperclass': 'book', +# mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) +# 'wrapperclass': 'book', 'date': '', 'releasename': 'Version', 'title': r'The Pyramid Web Framework', @@ -343,15 +349,16 @@ def frontmatter(name, arguments, options, content, lineno, return [nodes.raw( '', r""" -\frontmatter +% mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) +% \frontmatter % prevent part/chapter/section numbering -\setcounter{secnumdepth}{-2} +% \setcounter{secnumdepth}{-2} % suppress headers -\pagestyle{plain} +% \pagestyle{plain} % reset page counter -\setcounter{page}{1} +% \setcounter{page}{1} % suppress first toc pagenum -\addtocontents{toc}{\protect\thispagestyle{empty}} +% \addtocontents{toc}{\protect\thispagestyle{empty}} """, format='latex')] @@ -361,25 +368,32 @@ def mainmatter(name, arguments, options, content, lineno, return [nodes.raw( '', r""" -\mainmatter +% mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) +% \mainmatter % allow part/chapter/section numbering -\setcounter{secnumdepth}{2} +% \setcounter{secnumdepth}{2} % get headers back -\pagestyle{fancy} -\fancyhf{} -\renewcommand{\headrulewidth}{0.5pt} -\renewcommand{\footrulewidth}{0pt} -\fancyfoot[C]{\thepage} -\fancyhead[RO]{\rightmark} -\fancyhead[LE]{\leftmark} +% \pagestyle{fancy} +% \fancyhf{} +% \renewcommand{\headrulewidth}{0.5pt} +% \renewcommand{\footrulewidth}{0pt} +% \fancyfoot[C]{\thepage} +% \fancyhead[RO]{\rightmark} +% \fancyhead[LE]{\leftmark} """, format='latex')] def backmatter(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): - return [nodes.raw('', '\\backmatter\n\\setcounter{secnumdepth}{-1}\n', - format='latex')] + return [nodes.raw( + '', + r""" +% mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) +% \backmatter +% \setcounter{secnumdepth}{-1} + """, + format='latex')] def app_role(role, rawtext, text, lineno, inliner, options={}, content=[]): diff --git a/docs/typographical-conventions.rst b/docs/typographical-conventions.rst index f128effea..2bfe4ffa6 100644 --- a/docs/typographical-conventions.rst +++ b/docs/typographical-conventions.rst @@ -217,18 +217,6 @@ The version in which a feature is deprecated in a project is displayed as follow Use the ``require_csrf`` option or read :ref:`auto_csrf_checking` instead to have :class:`pyramid.exceptions.BadCSRFToken` exceptions raised. -.. _typographical-conventions-danger: - -Danger ------- - -Danger represents critical information related to a topic or concept, and should recommend to the user "don't do this dangerous thing". - -.. danger:: - - This is danger or an error. - - .. _typographical-conventions-warnings: Warnings @@ -265,18 +253,6 @@ See also See :ref:`Quick Tutorial section on Requirements `. -.. _typographical-conventions-todo: - -Todo ----- - -Todo items designated tasks that require further work. - -.. todo:: - - This is a todo item. - - .. _typographical-conventions-cross-references: Cross-references -- cgit v1.2.3 From d4be9a573c575ae38f38325e3e8332eb399ae87e Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 25 Apr 2018 02:40:44 -0700 Subject: Support xelatex for PDF output - Now with Unicode character support --- docs/Makefile | 8 +++++++- docs/conf.py | 11 +++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile index 411ff35df..1c752559c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -12,7 +12,7 @@ PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -.PHONY: help clean html text web pickle htmlhelp latex latexpdf changes linkcheck epub doctest +.PHONY: help clean html text web pickle htmlhelp latex latexpdf changes linkcheck epub doctest xelatexpdf help: @echo "Please use \`make ' where is one of" @@ -30,6 +30,12 @@ help: clean: -rm -rf $(BUILDDIR)/* +xelatexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through xelatex..." + $(MAKE) PDFLATEX=xelatex -C $(BUILDDIR)/latex all-pdf + @echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex." + html: mkdir -p $(BUILDDIR)/html $(BUILDDIR)/doctrees $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html diff --git a/docs/conf.py b/docs/conf.py index 5d68a73a3..c0cb2bdcb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -223,6 +223,17 @@ latex_domain_indices = False _PREAMBLE = r""" \usepackage[]{geometry} \geometry{bindingoffset=0.45in,textheight=7.25in,hdivide={0.5in,*,0.75in},vdivide={1in,7.25in,1in},papersize={7.5in,9.25in}} + +%XeLaTeX packages +\usepackage{xltxtra} +\usepackage{fontspec} %Font package +\usepackage{xunicode} + +%Select fonts +\setmainfont[Mapping=tex-text]{nimbusserif} +\setsansfont[Mapping=tex-text]{nimbussans} +\setmonofont{nimbusmono} + \hypersetup{ colorlinks=true, linkcolor=black, -- cgit v1.2.3 From 1c2e9d014177c304df9b49fc964781b0967552e7 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 16 May 2018 14:09:29 -0700 Subject: Remove lazy commenting. If a printed book format is ever desired again, then there are commits in the history that can be used as a reference and adapted for however it should be done in the future. --- docs/conf.py | 41 ----------------------------------------- 1 file changed, 41 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index c0cb2bdcb..993711807 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -290,14 +290,6 @@ _PREAMBLE = r""" \definecolor{VerbatimColor}{rgb}{1,1,1} \definecolor{VerbatimBorderColor}{rgb}{1,1,1} -% mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) -% \makeatletter -% \renewcommand{\py@noticestart@warning}{\py@heavybox} -% \renewcommand{\py@noticeend@warning}{\py@endheavybox} -% \renewcommand{\py@noticestart@note}{\py@heavybox} -% \renewcommand{\py@noticeend@note}{\py@endheavybox} -% \makeatother - % icons in note and warning boxes \usepackage{ifthen} @@ -334,8 +326,6 @@ _PREAMBLE = r""" latex_elements = { 'preamble': _PREAMBLE, -# mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) -# 'wrapperclass': 'book', 'date': '', 'releasename': 'Version', 'title': r'The Pyramid Web Framework', @@ -359,18 +349,6 @@ def frontmatter(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): return [nodes.raw( '', - r""" -% mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) -% \frontmatter -% prevent part/chapter/section numbering -% \setcounter{secnumdepth}{-2} -% suppress headers -% \pagestyle{plain} -% reset page counter -% \setcounter{page}{1} -% suppress first toc pagenum -% \addtocontents{toc}{\protect\thispagestyle{empty}} -""", format='latex')] @@ -378,20 +356,6 @@ def mainmatter(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): return [nodes.raw( '', - r""" -% mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) -% \mainmatter -% allow part/chapter/section numbering -% \setcounter{secnumdepth}{2} -% get headers back -% \pagestyle{fancy} -% \fancyhf{} -% \renewcommand{\headrulewidth}{0.5pt} -% \renewcommand{\footrulewidth}{0pt} -% \fancyfoot[C]{\thepage} -% \fancyhead[RO]{\rightmark} -% \fancyhead[LE]{\leftmark} -""", format='latex')] @@ -399,11 +363,6 @@ def backmatter(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): return [nodes.raw( '', - r""" -% mcdonc commented as part of lazy pdf fixing (pdf_rendering_fixes branch) -% \backmatter -% \setcounter{secnumdepth}{-1} - """, format='latex')] -- cgit v1.2.3 From 298e346e7c7db90a779cfb052a263e561e75a462 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 16 May 2018 23:34:09 -0700 Subject: Remove todo extension and configuration --- docs/conf.py | 4 ---- 1 file changed, 4 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 993711807..80585b336 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -53,7 +53,6 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinxcontrib.autoprogram', # enable pylons_sphinx_latesturl when this branch is no longer "latest" @@ -124,9 +123,6 @@ exclude_patterns = ['_themes/README.rst', ] # 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: -- cgit v1.2.3 From 54a21885712c6daf367393a0a9d788c2688c48cd Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 16 May 2018 23:35:30 -0700 Subject: Update Makefile and make scripts to use xelatex to build PDF --- docs/Makefile | 5 +++-- docs/make_book | 2 +- docs/make_pdf | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile index 1c752559c..91f36aefc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -12,7 +12,7 @@ PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -.PHONY: help clean html text web pickle htmlhelp latex latexpdf changes linkcheck epub doctest xelatexpdf +.PHONY: help clean html text web pickle htmlhelp latex latexpdf xelatexpdf changes linkcheck epub doctest help: @echo "Please use \`make ' where is one of" @@ -22,6 +22,7 @@ help: @echo " htmlhelp to make HTML files and a HTML help project" @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 " xelatexpdf to make LaTeX files and run them through xelatex" @echo " changes to make an overview over all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " epub to make an epub" @@ -74,7 +75,7 @@ latex: cp _static/latex-note.png $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make latexpdf' to build a PDF file from them." + @echo "Run \`make xelatexpdf' to build a PDF file from them." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex diff --git a/docs/make_book b/docs/make_book index 94e249441..c3d3743ae 100755 --- a/docs/make_book +++ b/docs/make_book @@ -1,4 +1,4 @@ #!/bin/sh -make clean latex SPHINXBUILD=../env/bin/sphinx-build BOOK=1 +make clean xelatexpdf SPHINXBUILD=../env/bin/sphinx-build BOOK=1 cd _build/latex && make all-pdf diff --git a/docs/make_pdf b/docs/make_pdf index 6c9863bc9..6cf0ff726 100755 --- a/docs/make_pdf +++ b/docs/make_pdf @@ -1,4 +1,4 @@ #!/bin/sh -make clean latex SPHINXBUILD=../env/bin/sphinx-build +make clean xelatexpdf SPHINXBUILD=../env/bin/sphinx-build cd _build/latex && make all-pdf -- cgit v1.2.3 From b1c8eb77e7c1f289f890066328eec6712713e06b Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 16 May 2018 23:36:18 -0700 Subject: Use actual tree output characters, now that we have Unicode support --- docs/quick_tutorial/requirements.rst | 18 +++++++++--------- docs/quick_tutorial/tutorial_approach.rst | 16 ++++++++-------- 2 files changed, 17 insertions(+), 17 deletions(-) (limited to 'docs') diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst index 6bb12c984..29f263176 100644 --- a/docs/quick_tutorial/requirements.rst +++ b/docs/quick_tutorial/requirements.rst @@ -79,15 +79,15 @@ will reside as we proceed through the tutorial: .. code-block:: text - `── ~ - `── projects - `── quick_tutorial - │── env - `── step_one - │── intro - │ │── __init__.py - │ `── app.py - `── setup.py + ~ + └── projects + └── quick_tutorial + ├── env + └── step_one + ├── intro + │ ├── __init__.py + │ └── app.py + └── setup.py For Linux, the commands to do so are as follows: diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst index 8da9f71b3..cbc5c3449 100644 --- a/docs/quick_tutorial/tutorial_approach.rst +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -23,14 +23,14 @@ below: .. code-block:: text quick_tutorial - │── env - `── request_response - `── tutorial - │ │── __init__.py - │ │── tests.py - │ `── views.py - │── development.ini - `── setup.py + ├── env + └── request_response + ├── tutorial + │ ├── __init__.py + │ ├── tests.py + │ └── views.py + ├── development.ini + └── setup.py Each of the directories in our ``quick_tutorial`` workspace (e.g., ``request_response``) is a *Python project* (except as noted for the ``hello_world`` step). The ``tutorial`` -- cgit v1.2.3 From 56cbb5242ced12a73d9e710fb7e227996b841ef1 Mon Sep 17 00:00:00 2001 From: Jason Williams Date: Mon, 11 Jun 2018 15:55:17 -0500 Subject: Add httpexception for status code 308 --- docs/api/httpexceptions.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/api/httpexceptions.rst b/docs/api/httpexceptions.rst index d4cf97f1d..e25a07cd5 100644 --- a/docs/api/httpexceptions.rst +++ b/docs/api/httpexceptions.rst @@ -51,6 +51,8 @@ .. autoexception:: HTTPTemporaryRedirect + .. autoexception:: HTTPPermanentRedirect + .. autoexception:: HTTPBadRequest .. autoexception:: HTTPUnauthorized -- cgit v1.2.3 From 819732eaaaa1225f1af6d1902fbb5a7dc89a42bf Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 20 Jun 2018 06:30:06 -0700 Subject: remove html_use_smartypants - for good, now that we specify Sphinx minimum version of 1.7.4 --- docs/conf.py | 2 -- 1 file changed, 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 80585b336..075345d8c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -171,8 +171,6 @@ html_last_updated_fmt = '%b %d, %Y' # Do not use smart quotes. smartquotes = False -# Remove next line when RTD goes to Sphinx==1.6.6 -html_use_smartypants = False # Output file base name for HTML help builder. htmlhelp_basename = 'pyramid' -- cgit v1.2.3 From eab50da2b27b74cd9f64f26f1f6c80935db242c8 Mon Sep 17 00:00:00 2001 From: Gerard Date: Thu, 28 Jun 2018 23:55:31 +0200 Subject: Typos changed --- docs/narr/myproject/myproject/templates/layout.jinja2 | 2 +- docs/quick_tour/logging/hello_world/templates/layout.jinja2 | 2 +- docs/quick_tour/package/hello_world/templates/layout.jinja2 | 2 +- docs/quick_tour/sessions/hello_world/templates/layout.jinja2 | 2 +- docs/quick_tour/sqla_demo/sqla_demo/templates/layout.jinja2 | 2 +- .../quick_tutorial/cookiecutters/cc_starter/templates/layout.jinja2 | 2 +- docs/tutorials/wiki/src/authorization/tutorial/templates/edit.pt | 2 +- docs/tutorials/wiki/src/authorization/tutorial/templates/login.pt | 2 +- docs/tutorials/wiki/src/authorization/tutorial/templates/view.pt | 2 +- .../tutorials/wiki/src/basiclayout/tutorial/templates/mytemplate.pt | 2 +- .../wiki/src/installation/tutorial/templates/mytemplate.pt | 2 +- docs/tutorials/wiki/src/models/tutorial/templates/mytemplate.pt | 2 +- docs/tutorials/wiki/src/tests/tutorial/templates/edit.pt | 2 +- docs/tutorials/wiki/src/tests/tutorial/templates/login.pt | 2 +- docs/tutorials/wiki/src/tests/tutorial/templates/mytemplate.pt | 2 +- docs/tutorials/wiki/src/tests/tutorial/templates/view.pt | 2 +- docs/tutorials/wiki/src/views/tutorial/templates/edit.pt | 2 +- docs/tutorials/wiki/src/views/tutorial/templates/view.pt | 2 +- .../wiki2/src/authentication/tutorial/templates/layout.jinja2 | 2 +- .../wiki2/src/authorization/tutorial/templates/layout.jinja2 | 2 +- .../wiki2/src/basiclayout/tutorial/templates/layout.jinja2 | 2 +- .../wiki2/src/installation/tutorial/templates/layout.jinja2 | 2 +- docs/tutorials/wiki2/src/models/tutorial/templates/layout.jinja2 | 2 +- docs/tutorials/wiki2/src/tests/tutorial/templates/layout.jinja2 | 2 +- docs/tutorials/wiki2/src/views/tutorial/templates/layout.jinja2 | 2 +- docs/whatsnew-1.0.rst | 6 +++--- 26 files changed, 28 insertions(+), 28 deletions(-) (limited to 'docs') diff --git a/docs/narr/myproject/myproject/templates/layout.jinja2 b/docs/narr/myproject/myproject/templates/layout.jinja2 index 1baca52bd..38f5ae7a8 100644 --- a/docs/narr/myproject/myproject/templates/layout.jinja2 +++ b/docs/narr/myproject/myproject/templates/layout.jinja2 @@ -16,7 +16,7 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +