From 807d5c77801e3d038aa21151235e91496b70fb84 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sun, 18 Nov 2018 21:13:11 -0600 Subject: Link to startup docs for more detail --- docs/narr/startup.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'docs/narr/startup.rst') diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 90792c0ff..be708dfc7 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -18,9 +18,11 @@ on your keyboard after typing ``pserve development.ini`` and the time the lines ``Serving on http://localhost:6543`` are output to your console. .. index:: - single: startup process + single: startup pair: settings; .ini +.. _the_startup_process: + The Startup Process ------------------- @@ -81,6 +83,8 @@ Here's a high-level time-ordered overview of what happens when you press :language: python :linenos: + .. _startup_constructor_arguments: + Note that the constructor function accepts a ``global_config`` argument, which is a dictionary of key/value pairs mentioned in the ``[DEFAULT]`` section of an ``.ini`` file (if :ref:`[DEFAULT] @@ -111,6 +115,8 @@ Here's a high-level time-ordered overview of what happens when you press dictionary captured via the ``**settings`` kwarg as its ``settings`` argument. + .. _startup_settings: + The ``settings`` dictionary contains all the options in the ``[app:main]`` section of our .ini file except the ``use`` option (which is internal to PasteDeploy) such as ``pyramid.reload_templates``, -- cgit v1.2.3 From 33a1ec755a5e128224f31550ae04462d225ca9fc Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sun, 18 Nov 2018 22:13:06 -0600 Subject: More index entries for ini files and configuration --- docs/narr/startup.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/narr/startup.rst') diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index be708dfc7..95673051e 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -83,6 +83,10 @@ Here's a high-level time-ordered overview of what happens when you press :language: python :linenos: + .. index:: + single: ini file + pair: PasteDeploy; configuration + .. _startup_constructor_arguments: Note that the constructor function accepts a ``global_config`` argument, -- cgit v1.2.3 From 401cf69020b888bf5343e211871a42d59494abd1 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sun, 18 Nov 2018 23:19:23 -0600 Subject: More explaination of calling Configurator() --- docs/narr/startup.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs/narr/startup.rst') diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 95673051e..5582f5ff4 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -115,9 +115,8 @@ Here's a high-level time-ordered overview of what happens when you press for the meanings of these keys. #. The ``main`` function first constructs a - :class:`~pyramid.config.Configurator` instance, passing the ``settings`` - dictionary captured via the ``**settings`` kwarg as its ``settings`` - argument. + :class:`~pyramid.config.Configurator` instance. + It holds the application's settings and is able to :term:`commit` any :term:`configuration declaration`\s the settings contain because the dictionary captured via the ``**settings`` kwarg is passed to the :class:`~pyramid.config.Configurator` in its``settings`` argument. .. _startup_settings: -- cgit v1.2.3 From 481ff76158333826f1de599c3b76e81981a2e8f0 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 19 Nov 2018 00:41:20 -0600 Subject: Make index entries for statup distinct --- docs/narr/startup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/narr/startup.rst') diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 5582f5ff4..5db45458d 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -18,7 +18,7 @@ on your keyboard after typing ``pserve development.ini`` and the time the lines ``Serving on http://localhost:6543`` are output to your console. .. index:: - single: startup + single: startup process pair: settings; .ini .. _the_startup_process: -- cgit v1.2.3 From 55b6122999b900b6f505dd9f7afbc91e2f22470b Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 19 Nov 2018 09:31:48 -0600 Subject: One sentence per line --- docs/narr/startup.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) (limited to 'docs/narr/startup.rst') diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 5db45458d..138ddbe67 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -167,9 +167,6 @@ Here's a high-level time-ordered overview of what happens when you press Deployment Settings ------------------- -Note that an augmented version of the values passed as ``**settings`` to the -:class:`~pyramid.config.Configurator` constructor will be available in -:app:`Pyramid` :term:`view callable` code as ``request.registry.settings``. You -can create objects you wish to access later from view code, and put them into -the dictionary you pass to the configurator as ``settings``. They will then be -present in the ``request.registry.settings`` dictionary at application runtime. +Note that an augmented version of the values passed as ``**settings`` to the :class:`~pyramid.config.Configurator` constructor will be available in :app:`Pyramid` :term:`view callable` code as ``request.registry.settings``. +You can create objects you wish to access later from view code, and put them into the dictionary you pass to the configurator as ``settings``. +They will then be present in the ``request.registry.settings`` dictionary at application runtime. -- cgit v1.2.3 From 617c68524a30fd32b742d7124b180e77845cc2da Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 19 Nov 2018 09:32:46 -0600 Subject: Change from future to present tense --- docs/narr/startup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/narr/startup.rst') diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 138ddbe67..65e74b262 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -167,6 +167,6 @@ Here's a high-level time-ordered overview of what happens when you press Deployment Settings ------------------- -Note that an augmented version of the values passed as ``**settings`` to the :class:`~pyramid.config.Configurator` constructor will be available in :app:`Pyramid` :term:`view callable` code as ``request.registry.settings``. +Note that an augmented version of the values passed as ``**settings`` to the :class:`~pyramid.config.Configurator` constructor is available in :app:`Pyramid` :term:`view callable` code as ``request.registry.settings``. You can create objects you wish to access later from view code, and put them into the dictionary you pass to the configurator as ``settings``. They will then be present in the ``request.registry.settings`` dictionary at application runtime. -- cgit v1.2.3 From 1a36d9a0d1295cc8c9e95e2ccc6d7f182f451792 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 19 Nov 2018 10:25:20 -0600 Subject: Shorter sentences are better --- docs/narr/startup.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/narr/startup.rst') diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 65e74b262..8e637f64c 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -114,9 +114,9 @@ Here's a high-level time-ordered overview of what happens when you press pyramid.includes = pyramid_debugtoolbar}``. See :ref:`environment_chapter` for the meanings of these keys. -#. The ``main`` function first constructs a - :class:`~pyramid.config.Configurator` instance. - It holds the application's settings and is able to :term:`commit` any :term:`configuration declaration`\s the settings contain because the dictionary captured via the ``**settings`` kwarg is passed to the :class:`~pyramid.config.Configurator` in its``settings`` argument. +#. The ``main`` function begins by making a :term:`configurator`. + The dictionary captured via the ``**settings`` kwarg is passed to the :class:`~pyramid.config.Configurator` constructor in its ``settings`` argument. + The new configurator holds the application's :term:`settings` and is able to :term:`commit` any :term:`configuration declaration`\s the settings contain. .. _startup_settings: -- cgit v1.2.3 From 8d2a89f53c99634443af5407fb8d1078d14c51d7 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 19 Nov 2018 10:25:51 -0600 Subject: The point of knowing what's in settings is to be able to use them --- docs/narr/startup.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/narr/startup.rst') diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index 8e637f64c..17926c716 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -124,6 +124,7 @@ Here's a high-level time-ordered overview of what happens when you press section of our .ini file except the ``use`` option (which is internal to PasteDeploy) such as ``pyramid.reload_templates``, ``pyramid.debug_authorization``, etc. + It is :ref:`available for use ` in your code. #. The ``main`` function then calls various methods on the instance of the class :class:`~pyramid.config.Configurator` created in the previous step. -- cgit v1.2.3