[Checkins] SVN: zope.event/branches/tseaver-new_style_docs/ Don't rely on collective.recipe.sphinxbuilder: just install Sphinx.

Tres Seaver tseaver at palladion.com
Sat May 1 13:36:26 EDT 2010


Log message for revision 111848:
  Don't rely on collective.recipe.sphinxbuilder:  just install Sphinx.
  

Changed:
  U   zope.event/branches/tseaver-new_style_docs/buildout.cfg
  U   zope.event/branches/tseaver-new_style_docs/docs/hacking.rst

-=-
Modified: zope.event/branches/tseaver-new_style_docs/buildout.cfg
===================================================================
--- zope.event/branches/tseaver-new_style_docs/buildout.cfg	2010-05-01 17:35:08 UTC (rev 111847)
+++ zope.event/branches/tseaver-new_style_docs/buildout.cfg	2010-05-01 17:36:26 UTC (rev 111848)
@@ -9,9 +9,7 @@
 eggs = zope.event
 
 [sphinx]
-recipe = collective.recipe.sphinxbuilder
-build = ${buildout:directory}/docs/_build
-source = ${buildout:directory}/docs
-outputs = doctest html
-script-name = make-docs
-extra-paths = ${buildout:directory}/src
+recipe = zc.recipe.egg
+eggs =
+    Sphinx
+    zope.event

Modified: zope.event/branches/tseaver-new_style_docs/docs/hacking.rst
===================================================================
--- zope.event/branches/tseaver-new_style_docs/docs/hacking.rst	2010-05-01 17:35:08 UTC (rev 111847)
+++ zope.event/branches/tseaver-new_style_docs/docs/hacking.rst	2010-05-01 17:36:26 UTC (rev 111848)
@@ -186,12 +186,13 @@
 Building the documentation using :mod:`zc.buildout`
 ---------------------------------------------------
 
-The :mod:`zope.event` buildout creates the necessary scripts to build
+The :mod:`zope.event` buildout installs the Sphinx scripts required to build
 the documentation, including testing its code snippets:
 
 .. code-block:: sh
 
-   $ bin/make-docs
+   $ cd docs
+   $ PATH=../bin:$PATH make doctest html
    .../bin/sphinx-build -b doctest -d .../docs/_build/doctrees   .../docs .../docs/_build/doctest
    running tests...
 



More information about the checkins mailing list