summaryrefslogtreecommitdiff
path: root/docs/narr/startup.rst
diff options
context:
space:
mode:
authorMichael Merickel <github@m.merickel.org>2018-11-24 14:41:38 -0600
committerGitHub <noreply@github.com>2018-11-24 14:41:38 -0600
commitffa3f92a59004f420bc818559da4445f26a8b4b2 (patch)
tree83610372e3cb7bb59e8abf0ee701108e020f844d /docs/narr/startup.rst
parent57c9362fb214e926f535961f3a78c54e0cce15ba (diff)
parenta86f9f56067c80eedbdabc4c983628e2aa31479d (diff)
downloadpyramid-ffa3f92a59004f420bc818559da4445f26a8b4b2.tar.gz
pyramid-ffa3f92a59004f420bc818559da4445f26a8b4b2.tar.bz2
pyramid-ffa3f92a59004f420bc818559da4445f26a8b4b2.zip
Merge pull request #3429 from kpinc/logging
Clarify startup and logging related docs
Diffstat (limited to 'docs/narr/startup.rst')
-rw-r--r--docs/narr/startup.rst29
1 files changed, 19 insertions, 10 deletions
diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst
index 17926c716..65669e0b9 100644
--- a/docs/narr/startup.rst
+++ b/docs/narr/startup.rst
@@ -47,10 +47,16 @@ Here's a high-level time-ordered overview of what happens when you press
the :term:`PasteDeploy` library and returns a parser that can understand
the format.
+.. _ini_section_discovery:
+
#. The :term:`PasteDeploy` finds a section named either ``[app:main]``,
- ``[pipeline:main]``, or ``[composite:main]`` in the ``.ini`` file. This
- section represents the configuration of a :term:`WSGI` application that will
- be served. If you're using a simple application (e.g., ``[app:main]``), the
+ ``[pipeline:main]``, or ``[composite:main]`` in the ``.ini`` file.
+ This section configures the :term:`WSGI` webserver which serves your application.
+ As such it is the ``ini`` section for your application and can be the source for many of your application's :term:`settings`.
+
+ .. _entry_point_discovery:
+
+ If you're using a simple application (e.g., ``[app:main]``), the
application's ``paste.app_factory`` :term:`entry point` will be named on the
``use=`` line within the section's configuration. If instead of a simple
application, you're using a WSGI :term:`pipeline` (e.g., a
@@ -63,17 +69,20 @@ Here's a high-level time-ordered overview of what happens when you press
will have a single ``[app:main]`` section in it, and this will be the
application served.
+.. index::
+ pair: logging; startup
+
+.. _startup_logging_initialization:
+
#. The framework finds all :mod:`logging` related configuration in the ``.ini``
file and uses it to configure the Python standard library logging system for
- this application. See :ref:`logging_config` for more information.
+ the application. See :ref:`logging_config` for more information.
-#. The application's *constructor* named by the entry point referenced on the
- ``use=`` line of the section representing your :app:`Pyramid` application is
- passed the key/value parameters mentioned within the section in which it's
- defined. The constructor is meant to return a :term:`router` instance,
- which is a :term:`WSGI` application.
+#. The application's entry point, usually the entry point referenced on the :ref:`above mentioned <entry_point_discovery>` ``use=`` line, is the application's :term:`constructor`.
+ It is passed the key/value parameters in :ref:`the application's .ini section <ini_section_discovery>`.
+ The constructor should return a :term:`router` instance, which is a :term:`WSGI` application.
- For :app:`Pyramid` applications, the constructor will be a function named
+ For :app:`Pyramid` applications, the constructor is a function named
``main`` in the ``__init__.py`` file within the :term:`package` in which
your application lives. If this function succeeds, it will return a
:app:`Pyramid` :term:`router` instance. Here's the contents of an example