More documentation on configuration by python code
authorKarl O. Pinc <kop@meme.com>
Wed, 14 Nov 2018 14:57:20 +0000 (08:57 -0600)
committerKarl O. Pinc <kop@meme.com>
Wed, 14 Nov 2018 14:57:20 +0000 (08:57 -0600)
README.rst

index f6d30998479c001baf70b3b096160c3f14dbb58d..c573c592e13f512f2007cc8fa04fd69b223c33da 100644 (file)
@@ -41,11 +41,14 @@ discovering and reporting as many errors as is possible per bulk
 interaction with the database.
 
 
-Usage
------
+Configuration By Python Code
+----------------------------
 
-To use pgwui_common configure your pyramid app by putting the
-following into your package's __init__.py::
+If you are writing a complete Pyramid application, or simply want full
+control over configuration you will need to make a Python
+distribution.  (Something to be installed, perhaps with ``pip``.)
+In this case use pgwui_common to configure your pyramid app by putting
+the following into your package's __init__.py::
 
     from pyramid.config import Configurator
 
@@ -55,7 +58,9 @@ following into your package's __init__.py::
 
 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).
+Override API.  See:
+`https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/assets.html#overriding-assets
+<https://docs.pylonsproject.org/projects/pyramid/en/latest/narr/assets.html#overriding-assets>`_
 
 
 Development Status