[Checkins] SVN: grok/trunk/ Restructured the upgrade and change documentation so that they now

[Kevin Gill]

Log message for revision 101470:
  Restructured the upgrade and change documentation so that they now
  get generated into separate files by Sphinx
  
  

Changed:
  U   grok/trunk/CHANGES.txt
  U   grok/trunk/doc/changes.rst
  A   grok/trunk/doc/upgrade.rst
  U   grok/trunk/doc/upgrade.txt

-=-
Modified: grok/trunk/CHANGES.txt
===================================================================
--- grok/trunk/CHANGES.txt	2009-07-04 07:36:40 UTC (rev 101469)
+++ grok/trunk/CHANGES.txt	2009-07-04 08:25:25 UTC (rev 101470)
@@ -4,6 +4,8 @@
 1.0b1 (unreleased)
 ==================
 
+See: :ref:`upgrade_notes_1.0b1` for special notes on upgrading to this release.
+
 * Removed `docutils` and `Pygment` from versions.cfg. Both are pinned
   in grokdocs subpackage. Closes
   https://bugs.launchpad.net/grok/+bug/340170
@@ -19,9 +21,11 @@
 * changed interpreter name from 'python' to 'grokpy'
 
 * Changed the default permission to grok.View instead of zope.Public. 
-  See the `upgrade notes`_(``doc/upgrade.txt``) for more information.
   https://bugs.launchpad.net/grok/+bug/387332
 
+* Restructured the upgrade and change documentation so that they now
+  get generated into separate files by Sphinx
+
 1.0a4 (2009-05-21)
 ==================
 
@@ -61,6 +65,8 @@
 1.0a1 (2009-01-08)
 ==================
 
+See: :ref:`upgrade_notes_1.0a1` for special notes on upgrading to this release.
+
 Feature changes
 ---------------
 
@@ -102,6 +108,8 @@
 0.14 (2008-09-29)
 =================
 
+See: :ref:`upgrade_notes_0.14` for special notes on upgrading to this release.
+
 Feature changes
 ---------------
 
@@ -148,6 +156,8 @@
 0.13 (2008-06-23)
 =================
 
+See: :ref:`upgrade_notes_0.13` for special notes on upgrading to this release.
+
 Restructuring
 -------------
 
@@ -163,9 +173,10 @@
 
 * Refactored class grokkers to make use of Martian's new declarative
   way for retrieving directive data from classes, and Martian's new
-  declarative way to write grokkers. See the `upgrade notes`_
-  (``doc/upgrade.txt``) for more information.
+  declarative way to write grokkers. See :ref:`upgrade_notes_0.13` 
+  for more information.
 
+
 Feature changes
 ---------------
 
@@ -199,7 +210,7 @@
   http://download.zope.org/zope3.4/versions-3.4.0c1.cfg
 
   We are now using the latest Zope 3 releases for all Zope packages.
-  For upgrade notes, see doc/upgrade.txt for more information.
+  See :ref:`upgrade_notes_0.13` for more information.
 
 * Added support for easier test setup based on ``z3c.testsetup``. This
   is a more stable and more powerful implementation of
@@ -258,6 +269,8 @@
 0.12 (2008-04-22)
 =================
 
+See: :ref:`upgrade_notes_0.12` for special notes on upgrading to this release.
+
 Feature changes
 ---------------
 
@@ -290,11 +303,8 @@
   classes. These classes need to have the grok.baseclass() directive added to
   them explicitly.
 
-  See also the `upgrade notes`_ for information on how to update
-  your existing projects.
+  See :ref:`upgrade_notes_0.12` for more information.
 
-.. _`upgrade notes`: http://grok.zope.org/project/upgrade-notes
-
 Bug fixes
 ---------
 
@@ -363,6 +373,8 @@
 0.11 (2007-11-08)
 =================
 
+See: :ref:`upgrade_notes_0.11` for special notes on upgrading to this release.
+
 Feature changes
 ---------------
 
@@ -419,8 +431,8 @@
 -------------
 
 * Grokkers now emit configuration actions, much like ZCML directive
-  handlers do. If you defined custom grokkers, see doc/upgrade.txt for
-  more information.
+  handlers do. If you defined custom grokkers, 
+  see :ref:`upgrade_notes_0.11` for more information.
 
 * The new pluggable template language support includes some restructuring:
 

Modified: grok/trunk/doc/changes.rst
===================================================================
--- grok/trunk/doc/changes.rst	2009-07-04 07:36:40 UTC (rev 101469)
+++ grok/trunk/doc/changes.rst	2009-07-04 08:25:25 UTC (rev 101470)
@@ -1,7 +1 @@
-
-.. include:: upgrade.txt
-
-.. _changes:
 .. include:: ../CHANGES.txt
-
-

Added: grok/trunk/doc/upgrade.rst
===================================================================
--- grok/trunk/doc/upgrade.rst	                        (rev 0)
+++ grok/trunk/doc/upgrade.rst	2009-07-04 08:25:25 UTC (rev 101470)
@@ -0,0 +1 @@
+.. include:: upgrade.txt

Modified: grok/trunk/doc/upgrade.txt
===================================================================
--- grok/trunk/doc/upgrade.txt	2009-07-04 07:36:40 UTC (rev 101469)
+++ grok/trunk/doc/upgrade.txt	2009-07-04 08:25:25 UTC (rev 101470)
@@ -1,3 +1,5 @@
+.. _upgrade_notes:
+
 Upgrade notes
 =============
 
@@ -6,6 +8,8 @@
 describes changes involving incompatibilities or deprecations, not new
 features (please refer to ``CHANGES.txt`` for those).
 
+.. _upgrade_notes_1.0b1:
+
 Upgrading to 1.0b1 (not released)
 ----------------------------------
 
@@ -42,6 +46,7 @@
 * Interpreter name has been changed from 'bin/python' to 'bin/grokpy' to
   avoid conflicts with 'virtualenv'.
 
+.. _upgrade_notes_1.0a1:
 
 Upgrading to 1.0a1
 ------------------
@@ -64,6 +69,7 @@
   As you can see, ``IRESTLayer`` has been introduced as a baseclass for
   defining REST layers.
 
+.. _upgrade_notes_0.14:
 
 Upgrading to 0.14
 -----------------
@@ -101,6 +107,7 @@
                         # Add extra requirements here
                         ],
 
+.. _upgrade_notes_0.13:
 
 Upgrading to 0.13
 -----------------
@@ -268,6 +275,7 @@
   than what it does before. Previous uses of ``view`` in a viewlet
   template should be renamed to ``viewlet``.
 
+.. _upgrade_notes_0.12:
 
 Upgrading to 0.12
 -----------------
@@ -298,6 +306,7 @@
   directive to these classes explicitly where the 'Base' class convention was
   relied upon to preserve existing functionality.
 
+.. _upgrade_notes_0.11:
 
 Upgrading to 0.11
 -----------------