From 17cf32a6cc2e977867429443d6d3a9514f9dbed0 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 21 Nov 2009 22:51:08 +0000 Subject: Add meager API docs for Configurator. --- docs/api/configuration.rst | 38 ++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 39 insertions(+) create mode 100644 docs/api/configuration.rst diff --git a/docs/api/configuration.rst b/docs/api/configuration.rst new file mode 100644 index 000000000..aec43178a --- /dev/null +++ b/docs/api/configuration.rst @@ -0,0 +1,38 @@ +.. _configuration_module: + +:mod:`repoze.bfg.configuration` +------------------------------- + +.. automodule:: repoze.bfg.configuration + + .. autoclass:: Configurator + + .. automethod:: route + + .. automethod:: view + + .. automethod:: authentication_policy(policy) + + .. automethod:: authorization_policy(policy) + + .. automethod:: forbidden(view=None, attr=None, renderer=None, wrapper=None) + + .. automethod:: notfound(view=None, attr=None, renderer=None, wrapper=None) + + .. automethod:: renderer(factory, name) + + .. automethod:: resource(to_override, override_with) + + .. automethod:: root_factory(factory) + + .. automethod:: scan(package) + + .. automethod:: settings + + .. automethod:: static(name, path, cache_max_age=3600) + + .. automethod:: load_zcml(spec) + + .. automethod:: make_wsgi_app() + + diff --git a/docs/index.rst b/docs/index.rst index c7be48142..9a45d91d1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -66,6 +66,7 @@ Per-module :mod:`repoze.bfg` API documentation. api/chameleon_text api/chameleon_zpt + api/configuration api/events api/exceptions api/location -- cgit v1.2.3