From f50042a225c85665a128de67f2a721e00f8f637d Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Thu, 25 Oct 2018 19:49:09 -0500 Subject: [PATCH] Move usage docs into README.rst --- README.rst | 17 +++++++++++++++++ src/pgwui_common/__init__.py | 14 -------------- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index 31bbd65..5dc6a74 100644 --- a/README.rst +++ b/README.rst @@ -41,6 +41,23 @@ discovering and reporting as many errors as is possible per bulk interaction with the database. +Usage +----- + +To use pgwui_common configure your pyramid app by putting the +following into your package's __init__.py:: + + from pyramid.config import Configurator + + def main(global_config, **settings): + config = Configurator() + config.include('pgwui_common') + +Note that you can override any of the assets in this package or any of +the PGWUI packages, any of the templates or css, using Pyramid's Asset +Override API (or via pyramid.includes = yourextension in the .ini file). + + Development Status ------------------ diff --git a/src/pgwui_common/__init__.py b/src/pgwui_common/__init__.py index 504dad1..2ab8c42 100644 --- a/src/pgwui_common/__init__.py +++ b/src/pgwui_common/__init__.py @@ -20,20 +20,6 @@ # Karl O. Pinc '''Provide a way to configure PGWUI. - -To use pgwui_common configure your pyramid app by putting the -following into your package's __init__.py: - - from pyramid.config import Configurator - - def main(global_config, **settings): - config = Configurator() - config.include('pgwui_common') - -Note that you can override any of the assets in this package or any of -the PGWUI packages, any of the templates or css, using Pyramid's Asset -Override API (or via pyramid.includes = yourextension in the .ini file). - ''' -- 2.34.1