[Checkins] SVN: docs.zope.org_website/ - adjusted filesystem paths

[Jens Vagelpohl]

Log message for revision 115272:
  - adjusted filesystem paths
  - expanded the README
  

Changed:
  U   docs.zope.org_website/README.txt
  U   docs.zope.org_website/buildout.cfg

-=-
Modified: docs.zope.org_website/README.txt
===================================================================
--- docs.zope.org_website/README.txt	2010-07-31 15:39:29 UTC (rev 115271)
+++ docs.zope.org_website/README.txt	2010-07-31 16:39:38 UTC (rev 115272)
@@ -10,15 +10,42 @@
 * Build an index file showing the documented packages
 
 
-How do I add or remove a package from a package list?
------------------------------------------------------
-Find the respective buildout stanza and remove or add the 
-Subversion URLs in the ``sources`` list. The URL must use 
+How do remove a package from a package list?
+--------------------------------------------
+Find the respective buildout stanza and remove the 
+Subversion URL in the ``sources`` list. 
+
+
+How do I add a package to a package list?
+-----------------------------------------
+If your newly added package has a standard Sphinx setup with 
+a ``doc`` or ``docs`` folder in the package root containing 
+the `Sphinx` documentation and configuration then this is 
+easy. Find the respective buildout stanza and add the Subversion
+URL to the list of URLs in ``sources``.  The URL must use 
 a protocol understood by Subversion, and it must point to 
-the `main` package location which has the package's 
+the main package location which has the package's 
 ``trunk`` folder in it.
 
+If your new package relies on the ``z3c.recipe.sphinxbuild``
+way of doing things it's a little more complicated. You should 
+consider converting it to the standard setup described above 
+with documentation and a Sphinx configuration stored in the 
+package root.
 
+First, you need to visit the ``z3c.recipe.sphinxbuild`` buildout 
+configuration at ``/home/zope/z3c.sphinxdocs``. Add your package 
+name to its buildout configuration, following the conventions 
+for the other packages. Make sure you create a trunk checkout 
+of your package underneath ``/home/zope/z3c.sphinxdocs`` 
+as well. Then re-run ``bin/buildout`` and ``bin/docs`` to build
+the documentation.
+
+When your ``z3c.recipe.sphinxbuild``-based documentation is built 
+you can add the package URL to the site buildout as explained in 
+the first paragraph.
+
+
 How do I add another packages set page?
 ---------------------------------------
 Start by copying an existing buildout stanza. Then change 

Modified: docs.zope.org_website/buildout.cfg
===================================================================
--- docs.zope.org_website/buildout.cfg	2010-07-31 15:39:29 UTC (rev 115271)
+++ docs.zope.org_website/buildout.cfg	2010-07-31 16:39:38 UTC (rev 115272)
@@ -11,8 +11,8 @@
 eggs =  
 index-template = ${buildout:directory}/templates
 index-name = ztkpackages
-output-directory = ${buildout:directory}/output
-z3csphinx-output-directory = /usr/local/nobackup/z3c.zopedocs/parts/docs
+output-directory = /var/www/docs.zope.org
+z3csphinx-output-directory = /home/zope/z3c.zopedocs/parts/docs
 sources =
     http://svn.zope.org/repos/main/zope.annotation
     http://svn.zope.org/repos/main/zope.applicationcontrol
@@ -88,8 +88,8 @@
 eggs =  
 index-template = ${buildout:directory}/templates
 index-name = ztkapppackages
-output-directory = ${buildout:directory}/output
-z3csphinx-output-directory = /usr/local/nobackup/z3c.zopedocs/parts/docs
+output-directory = /var/www/docs.zope.org
+z3csphinx-output-directory = /home/zope/z3c.zopedocs/parts/docs
 sources =
     http://svn.zope.org/repos/main/zope.app.apidoc
     http://svn.zope.org/repos/main/zope.app.applicationcontrol
@@ -161,8 +161,8 @@
 trunk-only = True
 index-template = ${buildout:directory}/templates
 index-name = zope2packages
-output-directory = ${buildout:directory}/output
-z3csphinx-output-directory = /usr/local/nobackup/z3c.zopedocs/parts/docs
+output-directory = /var/www/docs.zope.org
+z3csphinx-output-directory = /home/zope/z3c.zopedocs/parts/docs
 eggs =
 sources = 
     svn://svn.zope.org/repos/main/Zope
@@ -196,13 +196,12 @@
 trunk-only = True
 index-template = ${buildout:directory}/templates
 index-name = z3cpackages
-output-directory = ${buildout:directory}/output
-z3csphinx-output-directory = /usr/local/nobackup/z3c.zopedocs/parts/docs
+output-directory = /var/www/docs.zope.org
+z3csphinx-output-directory = /home/zope/z3c.zopedocs/parts/docs
 eggs =
 sources = 
     svn://svn.zope.org/repos/main/z3c.form
     svn://svn.zope.org/repos/main/z3c.formjs
-    svn://svn.zope.org/repos/main/z3c.table
     svn://svn.zope.org/repos/main/z3c.boiler
     svn://svn.zope.org/repos/main/z3c.feature.core
     svn://svn.zope.org/repos/main/z3c.feature.zope