[Checkins] SVN: Sandbox/ulif/grok-reference-with-rest3/doc/build/ Incorporate changes file.

Uli Fouquet uli at gnufix.de
Sat Feb 23 11:32:39 EST 2008


Log message for revision 84191:
  Incorporate changes file.

Changed:
  U   Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template
  U   Sandbox/ulif/grok-reference-with-rest3/doc/build/grokdocs.py

-=-
Modified: Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template	2008-02-23 15:50:12 UTC (rev 84190)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/build/docindex.template	2008-02-23 16:32:39 UTC (rev 84191)
@@ -1,13 +1,28 @@
-
+  <p><strong>Parts of the documentation:</strong></p>
   <table class="contentstable" align="center"><tr>
     <td width="50%">
+      <p class="biglink"><a class="biglink" href="{{ pathto("changes") }}"
+      >What's new in Grok {{ version }}?</a><br>
+      <span class="linkdescr">changes during the releases</span></p>
+
+      <p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}"
+      >Tutorial</a><br>
+      <span class="linkdescr">Get started with Grok</span></p>
+
+      <p class="biglink"><a class="biglink" href="{{ pathto("minitutorials/index") }}"
+      >Grok HOWTOS</a><br>
+      <span class="linkdescr">in-depth documents on specific topics</span></p>
+
+    </td><td width="50%">
+
       <p class="biglink"><a class="biglink" href="{{ pathto("about") }}"
       >About Grok</a><br>
       <span class="linkdescr">now even Cavemen can use Zope 3</span></p>
-    </td><td width="50%">
-      <p class="biglink"><a class="biglink" href="{{ pathto("tutorial") }}"
-      >Tutorial</a><br>
-      <span class="linkdescr">Get started with Grok</span></p>
+
+      <p class="biglink"><a class="biglink" href="{{ pathto("reference/index") }}">The Grok Reference</a><br>
+         <span class="linkdescr">describes syntax and package elements</span></p>
+
+
     </td></tr>
   </table>
   <p><strong>Indices and tables:</strong></p>
@@ -18,8 +33,6 @@
       <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search page</a><br>
          <span class="linkdescr">search this documentation</span></p>
     </td><td width="50%">
-      <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">Global Module Index</a><br>
-         <span class="linkdescr">quick access to all modules</span></p>
       <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br>
          <span class="linkdescr">all functions, classes, terms</span></p>
     </td></tr>

Modified: Sandbox/ulif/grok-reference-with-rest3/doc/build/grokdocs.py
===================================================================
--- Sandbox/ulif/grok-reference-with-rest3/doc/build/grokdocs.py	2008-02-23 15:50:12 UTC (rev 84190)
+++ Sandbox/ulif/grok-reference-with-rest3/doc/build/grokdocs.py	2008-02-23 16:32:39 UTC (rev 84191)
@@ -15,6 +15,7 @@
 """
 import sys
 import os.path
+from shutil import copyfile
 import getopt
 from extensions import pygments_directive
 import sphinx
@@ -71,10 +72,20 @@
                  default_out=HTMLDIR_REF)
 
 
+def copy_changes():
+    """Copy changes file into doc/ directory.
+    """
+    change_file = os.path.dirname(
+        os.path.dirname(os.path.dirname(__file__)))
+    change_file = os.path.join(change_file, 'CHANGES.txt')
+    target = os.path.join(os.path.dirname(change_file),
+                          'doc', 'changes.rst')
+    copyfile(change_file, target)
 
 def grokdocs(argv=sys.argv, srcdir=SRCDIR_ALL, htmldir=HTMLDIR_ALL):
     """Generate the whole docs, including howtos, reference, etc.
     """
+    copy_changes()
     if srcdir == SRCDIR_ALL:
         sphinx.usage = usage_grokdoc
     if not sys.stdout.isatty() or sys.platform == 'win32':



More information about the Checkins mailing list