added a releae guide to devel docs

jdh2358 · jdh2358 · commit 991263e6a401 · 2008-06-19T19:24:45.000Z
svn path=/trunk/matplotlib/; revision=5599
diff --git a/doc/devel/index.rst b/doc/devel/index.rst
@@ -14,6 +14,7 @@
 
    coding_guide.rst
    documenting_mpl.rst
+   release_guide.rst
    transformations.rst
    add_new_projection.rst
    outline.rst
diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst
@@ -0,0 +1,86 @@
+.. _release-guide:
+
+*************************
+Doing a matplolib release
+*************************
+
+A guide for developers who are doing a matplotlib release
+
+* Edit :file:`__init__.py` and bump the version number
+
+
+.. _release-testing:
+
+Testing
+=======
+
+* Make sure :file:`examples/tests/backend_driver.py` runs without errors
+  and check the output of the PNG, PDF, PS and SVG backends
+
+* Run :file:`unit/memleak_hawaii3.py` and make sure there are no
+  memory leaks
+
+* try some GUI examples, eg :file:`simple_plot.py` with GTKAgg, TkAgg, etc...
+
+* remove font cache and tex cache from :file:`.matplotlib` and test
+  with and without cache on some example script
+
+.. _release-packaging:
+
+Packaging
+=========
+
+* Make sure the :file:`MANIFEST.in` us up to date and remove
+  :file:`MANIFEST` so it will be rebuilt by MANIFEST.in
+
+* run `svn-clean
+  <http://svn.collab.net/repos/svn/trunk/contrib/client-side/svn-clean>`_
+  from in the mpl svn directory before building the sdist
+
+* unpack the sdist and make sure you can build from that directory
+
+* Use :file:`setup.cfg` to set the default backends.  For windows and
+  OSX, the default backend should be TkAgg.
+
+* on windows, unix2dos the rc file
+
+.. _release-uploading:
+
+Uploading
+=========
+
+* Post the win32 and OS-X binaries for testing and make a request on
+  matplotlib-devel for testing.  Pester us if we don't respond
+
+
+* ftp the source and binaries to the anonymous FTP site::
+
+    local> cd dist
+    local> ncftp upload.sourceforge.net
+    ncftp> cd incoming
+    ncftp> put tar.gz, zip exe
+
+* go https://sourceforge.net/project/admin/?group_id=80706 and do a
+  file release.  Click on the "Admin" tab to log in as an admin, and
+  then the "File Releases" tab.  Go to the bottom and click "add
+  release" and enter the package name but not the version number in
+  the "Package Name" box.  You will then be prompted for the "New
+  release name" at which point you can add the version number, eg
+  somepackage-0.1 and click "Create this release".
+
+  You will then be taken to a fairly self explanatory page where you
+  can enter the Change notes, the release notes, and select which
+  packages from the incoming ftp archive you want to include in this
+  release.  For each binary, you will need to select the platform and
+  file type, and when you are done you click on the "notify users who
+  are monitoring this package link"
+
+
+.. _release-announcing:
+
+Announcing
+==========
+
+Announce the release on matplotlib-announce, matplotlib-users and
+matplotlib-devel.  Include a summary of highlights from the CHANGELOG
+and/or post the whole CHANGELOG since the last release.
diff --git a/doc/faq/environment_variables_faq.rst b/doc/faq/environment_variables_faq.rst
@@ -4,6 +4,8 @@
 Environment Variables
 *********************
 
+.. contents::
+
 .. envvar:: HOME
 
   The user's home directory. On linux, :envvar:`~ <HOME>` is shorthand for :envvar:`HOME`.
diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst
@@ -4,6 +4,9 @@
 Howto
 *****
 
+.. contents::
+
+
 .. _howto-subplots-adjust:
 
 How do I move the edge of my axes area over to make room for my tick labels?
diff --git a/doc/faq/installing_faq.rst b/doc/faq/installing_faq.rst
@@ -4,6 +4,7 @@
  Installation
 *************
 
+.. contents::
 
 
 How do I report a compilation problem?
diff --git a/doc/faq/troubleshooting_faq.rst b/doc/faq/troubleshooting_faq.rst
@@ -4,6 +4,8 @@
 Troubleshooting
 ***************
 
+.. contents::
+
 .. _matplotlib-version:
 
 What is my matplotlib version?
