Commit 2b19a9bd authored by Tres Seaver's avatar Tres Seaver

Set up building the docs, and document how.

parent 89d4b184
...@@ -18,7 +18,7 @@ parts = ...@@ -18,7 +18,7 @@ parts =
zopepy zopepy
alltests alltests
allpy allpy
docs sphinx
checkversions checkversions
wsgi wsgi
sources-dir = develop sources-dir = develop
...@@ -86,10 +86,13 @@ interpreter = allpy ...@@ -86,10 +86,13 @@ interpreter = allpy
scripts = allpy scripts = allpy
[docs] [sphinx]
recipe = zc.recipe.egg recipe = collective.recipe.sphinxbuilder
eggs = Sphinx build = ${buildout:directory}/docs/_build
source = ${buildout:directory}/docs
outputs = html
script-name = make-docs
extra-paths = ${buildout:directory}
[checkversions] [checkversions]
recipe = zc.recipe.egg recipe = zc.recipe.egg
......
...@@ -187,3 +187,12 @@ used to automate this whole process. ...@@ -187,3 +187,12 @@ used to automate this whole process.
After installation, refer to :doc:`operation` for documentation on After installation, refer to :doc:`operation` for documentation on
configuring and running Zope. configuring and running Zope.
Building the documentation with ``Sphinx``
------------------------------------------
To build the HTML documentation, run the :command:`make-docs` script (installed
by the buildout)::
$ bin/make-docs
...@@ -4,9 +4,8 @@ Configuring and Running Zope ...@@ -4,9 +4,8 @@ Configuring and Running Zope
.. highlight:: bash .. highlight:: bash
Whichever method you used to install Zope and create a server instance (see After installing Zope and create a server instance (see :doc:`INSTALL`), the
:doc:`INSTALL` and :doc:`INSTALL-buildout`), the end result is configured end result is configured and operated as follows.
and operated the same way.
Configuring Zope Configuring Zope
......
...@@ -61,6 +61,7 @@ zope.schema = 4.4.2 ...@@ -61,6 +61,7 @@ zope.schema = 4.4.2
zope.traversing = 4.0.0 zope.traversing = 4.0.0
# Zope2 dependencies # Zope2 dependencies
collective.recipe.sphinxbuilder = 0.8.2
mechanize = 0.2.5 mechanize = 0.2.5
repoze.retry = 1.3 repoze.retry = 1.3
repoze.tm2 = 2.0 repoze.tm2 = 2.0
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment