[Checkins] SVN: zope.component/trunk/ Add sphinx-based documentation building.

[Dan Korostelev]

Log message for revision 97422:
  Add sphinx-based documentation building.

Changed:
  _U  zope.component/trunk/
  U   zope.component/trunk/CHANGES.txt
  U   zope.component/trunk/buildout.cfg
  U   zope.component/trunk/setup.py
  A   zope.component/trunk/src/zope/component/index.txt
  U   zope.component/trunk/src/zope/component/zcml.txt

-=-

Property changes on: zope.component/trunk
___________________________________________________________________
Modified: svn:ignore
   - bin
build
dist
lib
develop-eggs
eggs
parts
.installed.cfg

   + bin
build
dist
lib
develop-eggs
eggs
parts
.installed.cfg
docs


Modified: zope.component/trunk/CHANGES.txt
===================================================================
--- zope.component/trunk/CHANGES.txt	2009-03-02 16:04:28 UTC (rev 97421)
+++ zope.component/trunk/CHANGES.txt	2009-03-02 16:09:01 UTC (rev 97422)
@@ -4,7 +4,8 @@
 3.6.0 (unreleased)
 ==================
 
-- Cleanup package documentation and changelog a bit.
+- Cleanup package documentation and changelog a bit. Add sphinx-based
+  documentation building command to the buildout.
 
 - Remove deprecated code.
 

Modified: zope.component/trunk/buildout.cfg
===================================================================
--- zope.component/trunk/buildout.cfg	2009-03-02 16:04:28 UTC (rev 97421)
+++ zope.component/trunk/buildout.cfg	2009-03-02 16:09:01 UTC (rev 97422)
@@ -1,12 +1,19 @@
 [buildout]
 develop = .
-parts = test py
+parts = test python docs
 
 [test]
 recipe = zc.recipe.testrunner
 eggs = zope.component [test,zcml]
 
-[py]
+[python]
 recipe = zc.recipe.egg
-interpreter = py
+interpreter = python
 eggs = ${test:eggs}
+
+[docs]
+recipe = z3c.recipe.sphinxdoc
+eggs = zope.component [docs]
+build-dir = ${buildout:directory}/docs
+default.css =
+layout.html =

Modified: zope.component/trunk/setup.py
===================================================================
--- zope.component/trunk/setup.py	2009-03-02 16:04:28 UTC (rev 97421)
+++ zope.component/trunk/setup.py	2009-03-02 16:09:01 UTC (rev 97422)
@@ -67,6 +67,8 @@
     include_package_data = True,
     zip_safe = False,
     extras_require = dict(
+        hook = ['zope.hookable'],
+        persistentregistry = ['ZODB3'],
         zcml = ['zope.configuration',
                 'zope.security',
                 'zope.proxy',
@@ -77,7 +79,6 @@
                 'zope.hookable',
                 'zope.location',
                 ],
-        hook = ['zope.hookable'],
-        persistentregistry = ['ZODB3'],
+        docs = ['z3c.recipe.sphinxdoc'],
         ),
     )

Added: zope.component/trunk/src/zope/component/index.txt
===================================================================
--- zope.component/trunk/src/zope/component/index.txt	                        (rev 0)
+++ zope.component/trunk/src/zope/component/index.txt	2009-03-02 16:09:01 UTC (rev 97422)
@@ -0,0 +1,22 @@
+Welcome to zope.component's documentation!
+==========================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   README
+   socketexample
+   event
+   factory
+   registry
+   persistentregistry
+   zcml
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

Modified: zope.component/trunk/src/zope/component/zcml.txt
===================================================================
--- zope.component/trunk/src/zope/component/zcml.txt	2009-03-02 16:04:28 UTC (rev 97421)
+++ zope.component/trunk/src/zope/component/zcml.txt	2009-03-02 16:09:01 UTC (rev 97422)
@@ -917,6 +917,8 @@
 Protected utilities
 ~~~~~~~~~~~~~~~~~~~
 
+TODO::
+
     def testProtectedUtility(self):
         """Test that we can protect a utility.