[Checkins] SVN: zope.schema/trunk/ Add sphinx documentation generation part.

Dan Korostelev nadako at gmail.com
Mon Mar 9 19:30:21 EDT 2009


Log message for revision 97743:
  Add sphinx documentation generation part.

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

-=-
Modified: zope.schema/trunk/CHANGES.txt
===================================================================
--- zope.schema/trunk/CHANGES.txt	2009-03-09 23:24:48 UTC (rev 97742)
+++ zope.schema/trunk/CHANGES.txt	2009-03-09 23:30:21 UTC (rev 97743)
@@ -13,6 +13,8 @@
 
 - Fix package's documentation formatting. Change package's description.
 
+- Add buildout part that builds Sphinx-generated documentation.
+
 - Remove zpkg-related file.
 
 3.5.2 (2009-02-04)

Modified: zope.schema/trunk/buildout.cfg
===================================================================
--- zope.schema/trunk/buildout.cfg	2009-03-09 23:24:48 UTC (rev 97742)
+++ zope.schema/trunk/buildout.cfg	2009-03-09 23:30:21 UTC (rev 97743)
@@ -1,7 +1,14 @@
 [buildout]
 develop = .
-parts = test
+parts = test docs
 
 [test]
 recipe = zc.recipe.testrunner
 eggs = zope.schema
+
+[docs]
+recipe = z3c.recipe.sphinxdoc
+eggs = zope.schema [docs]
+build-dir = ${buildout:directory}/docs
+default.css =
+layout.html =

Modified: zope.schema/trunk/setup.py
===================================================================
--- zope.schema/trunk/setup.py	2009-03-09 23:24:48 UTC (rev 97742)
+++ zope.schema/trunk/setup.py	2009-03-09 23:30:21 UTC (rev 97743)
@@ -40,7 +40,8 @@
       packages=find_packages('src'),
       package_dir = {'': 'src'},
       namespace_packages=['zope',],
-      extras_require={'test': ['zope.testing']},
+      extras_require={'test': ['zope.testing'],
+                      'docs': ['z3c.recipe.sphinxdoc']},
       install_requires=['setuptools',
                         'zope.i18nmessageid',
                         'zope.interface',

Added: zope.schema/trunk/src/zope/schema/index.txt
===================================================================
--- zope.schema/trunk/src/zope/schema/index.txt	                        (rev 0)
+++ zope.schema/trunk/src/zope/schema/index.txt	2009-03-09 23:30:21 UTC (rev 97743)
@@ -0,0 +1,19 @@
+Welcome to zope.schema's documentation!
+=======================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   README
+   fields
+   sources
+   validation
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`



More information about the Checkins mailing list