summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2015-02-11 12:32:26 -0600
committerMichael Merickel <michael@merickel.org>2015-02-11 12:32:35 -0600
commit6e9e2dbb364f371b034b681dd44e6e6b831c5760 (patch)
treeb7d8c623706f5df330d9c72d4e1c9d84dd47b6cd /docs/api
parent14126cae5cf308ed466ed3eea576094e9c2193b4 (diff)
parent1dc1f28e1184960f5359c6c510d23a0e6e9dafe8 (diff)
downloadpyramid-6e9e2dbb364f371b034b681dd44e6e6b831c5760.tar.gz
pyramid-6e9e2dbb364f371b034b681dd44e6e6b831c5760.tar.bz2
pyramid-6e9e2dbb364f371b034b681dd44e6e6b831c5760.zip
Merge branch 'master' into feature.py3-coverage
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/index.rst12
-rw-r--r--docs/api/interfaces.rst3
-rw-r--r--docs/api/registry.rst12
3 files changed, 27 insertions, 0 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 000000000..cb38aa0b2
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,12 @@
+.. _html_api_documentation:
+
+API Documentation
+=================
+
+Comprehensive reference material for every public API exposed by :app:`Pyramid`:
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ *
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
index a62976d8a..de2a664a4 100644
--- a/docs/api/interfaces.rst
+++ b/docs/api/interfaces.rst
@@ -56,6 +56,9 @@ Other Interfaces
.. autointerface:: IRenderer
:members:
+ .. autointerface:: IResponseFactory
+ :members:
+
.. autointerface:: IViewMapperFactory
:members:
diff --git a/docs/api/registry.rst b/docs/api/registry.rst
index bab3e26ba..57a80b3f5 100644
--- a/docs/api/registry.rst
+++ b/docs/api/registry.rst
@@ -14,6 +14,18 @@
accessed as ``request.registry.settings`` or
``config.registry.settings`` in a typical Pyramid application.
+ .. attribute:: package_name
+
+ .. versionadded:: 1.6
+
+ When a registry is set up (or created) by a :term:`Configurator`, this
+ attribute will be the shortcut for
+ :attr:`pyramid.config.Configurator.package_name`.
+
+ This attribute is often accessed as ``request.registry.package_name`` or
+ ``config.registry.package_name`` or ``config.package_name``
+ in a typical Pyramid application.
+
.. attribute:: introspector
.. versionadded:: 1.3