summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-05-28 13:49:18 +0000
committerChris McDonough <chrism@agendaless.com>2009-05-28 13:49:18 +0000
commit82fefc4220a26b37484d2c79db4fdaeb9aebf7e9 (patch)
treef58149ef83b2bd8748751230d6691dc442100d08 /docs
parent5968cd6ab617d6b25a43cd3bd3866d4a8f635638 (diff)
downloadpyramid-82fefc4220a26b37484d2c79db4fdaeb9aebf7e9.tar.gz
pyramid-82fefc4220a26b37484d2c79db4fdaeb9aebf7e9.tar.bz2
pyramid-82fefc4220a26b37484d2c79db4fdaeb9aebf7e9.zip
- Add a ``get_app`` API functions to the ``paster`` module. This
obtains a WSGI application from a config file given a config file name and a section name. See the ``repoze.bfg.paster`` API docs for more information. - Add a new module named ``scripting``. It contains a ``get_root`` API function, which, provided a Router instance, returns a traversal root object and a "closer". See the ``repoze.bfg.scripting`` API docs for more info.
Diffstat (limited to 'docs')
-rw-r--r--docs/api/paster.rst8
-rw-r--r--docs/api/scripting.rst9
-rw-r--r--docs/index.rst1
3 files changed, 18 insertions, 0 deletions
diff --git a/docs/api/paster.rst b/docs/api/paster.rst
new file mode 100644
index 000000000..52b3048c1
--- /dev/null
+++ b/docs/api/paster.rst
@@ -0,0 +1,8 @@
+.. _paster_module:
+
+:mod:`repoze.bfg.paster`
+---------------------------
+
+.. automodule:: repoze.bfg.paster
+
+ .. autofunction:: get_app(config_file, name)
diff --git a/docs/api/scripting.rst b/docs/api/scripting.rst
new file mode 100644
index 000000000..afb86d9bb
--- /dev/null
+++ b/docs/api/scripting.rst
@@ -0,0 +1,9 @@
+.. _scripting_module:
+
+:mod:`repoze.bfg.scripting`
+---------------------------
+
+.. automodule:: repoze.bfg.scripting
+
+ .. autofunction:: get_root
+
diff --git a/docs/index.rst b/docs/index.rst
index c1efadb42..56729bac8 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -57,6 +57,7 @@ Per-module :mod:`repoze.bfg` API documentation.
api/location
api/push
api/router
+ api/scripting
api/security
api/template
api/testing