[Checkins] SVN: z3c.autoinclude/trunk/README.txt Make this proper reST
Hanno Schlichting
hannosch at hannosch.eu
Sat Dec 19 13:12:06 EST 2009
Log message for revision 106781:
Make this proper reST
Changed:
U z3c.autoinclude/trunk/README.txt
-=-
Modified: z3c.autoinclude/trunk/README.txt
===================================================================
--- z3c.autoinclude/trunk/README.txt 2009-12-19 17:52:51 UTC (rev 106780)
+++ z3c.autoinclude/trunk/README.txt 2009-12-19 18:12:06 UTC (rev 106781)
@@ -1,3 +1,6 @@
+Overview
+========
+
This package adds two new ZCML directives to automatically detect
ZCML files to include: "includeDependencies" and "includePlugins".
@@ -11,7 +14,8 @@
z3c.autoinclude lets you circumvent this error-prone process with
automatic detection and inclusion of ZCML files.
-== includeDependencies ==
+includeDependencies
+-------------------
The "includeDependencies" directive searches through the dependencies
in your setup.py file (install_requires), and includes the ZCML files
@@ -30,7 +34,8 @@
directive in the ZCML of the project it generates. You can then stop
worrying about manual ZCML inclusion in the vast majority of cases.
-== includePlugins ==
+includePlugins
+--------------
The "includePlugins" directive uses entry points to find installed
packages that broadcast themselves as plugins to a particular base
@@ -48,9 +53,11 @@
target = my_base
"""
-== The Details ==
+The Details
+===========
-=== Setup ===
+Setup
+-----
To make the z3c.autoinclude directives available for use in your
application or framework, you need to include it (in your
@@ -60,7 +67,8 @@
Grok already does this for you automatically.
-=== Disabling z3c.autoinclude ===
+Disabling z3c.autoinclude
+-------------------------
It is often useful to disable z3c.autoinclude's functionality for
debugging purposes or test runs. To disable autoinclusion, set
@@ -70,7 +78,8 @@
When autoinclusion is disabled, the autoinclusion directives will
issue a warning to the log and do nothing.
-=== ZCML Filenames ===
+ZCML Filenames
+--------------
The includeDependencies directive automatically includes
``configure.zcml`` and ``meta.zcml`` files that live in the main
More information about the checkins
mailing list