[Zope3-checkins] SVN: Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/ Convert text files to ReST.

[Fred L. Drake, Jr.]

Log message for revision 26587:
  Convert text files to ReST.


Changed:
  U   Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/README.txt
  U   Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/TODO.txt


-=-
Modified: Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/README.txt
===================================================================
--- Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/README.txt	2004-07-16 18:26:20 UTC (rev 26586)
+++ Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/README.txt	2004-07-16 19:01:09 UTC (rev 26587)
@@ -9,25 +9,26 @@
 Developing a Module
 -------------------
 
-  1. Implement a class that realizes the 'IDocumentationModule' interface.
+1. Implement a class that realizes the `IDocumentationModule`
+   interface.
 
-  2. Register this class as a utility using something like this::
+2. Register this class as a utility using something like this::
 
-    <utility
-        provides="zope.app.apidoc.interfaces.IDocumentationModule"
-        factory=".examplemodule.ExampleModule"
-        name="Example" />
+     <utility
+         provides="zope.app.apidoc.interfaces.IDocumentationModule"
+         factory=".examplemodule.ExampleModule"
+         name="Example" />
 
-  3. Take care of security by allowing at least 'IDocumentationModule':
+3. Take care of security by allowing at least `IDocumentationModule`::
 
-    <class class=".ExampleModule">
-      <allow interface="zope.app.apidoc.interfaces.IDocumentationModule" />
-    </class>
+     <class class=".ExampleModule">
+       <allow interface="zope.app.apidoc.interfaces.IDocumentationModule" />
+     </class>
 
-  4. Provide a browser view called 'menu.html'.
+4. Provide a browser view called ``menu.html``.
 
-  5. Provide another view, usually 'index.html', that can show the details for
-     the various menu items.
+5. Provide another view, usually ``index.html``, that can show the
+   details for the various menu items.
 
-  Note: There are several modules that come with the product. Just look in
-  them for some guidance.
+Note:  There are several modules that come with the product. Just look
+in them for some guidance.

Modified: Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/TODO.txt
===================================================================
--- Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/TODO.txt	2004-07-16 18:26:20 UTC (rev 26586)
+++ Zope3/branches/ZopeX3-3.0/src/zope/app/apidoc/TODO.txt	2004-07-16 19:01:09 UTC (rev 26587)
@@ -1,6 +1,6 @@
 TO DO
 =====
   
-  - better README.txt
+- better README.txt
 
-  - Refactor some of the views, so that templates can be reused
+- Refactor some of the views, so that templates can be reused