Skip to content

Commit

Permalink
Doc how to use ZServer nowadays (#250)
Browse files Browse the repository at this point in the history
* Document how to use ZServer instead of WSGI.

* Prevent an error about a wrong setuptools version while installing collective.recipe.sphinxbuilder.

* Use nice CSS when creating the documentation by a user as documented.
  • Loading branch information
Michael Howitz committed Feb 9, 2018
1 parent c0df6de commit 53ce057
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 3 deletions.
13 changes: 11 additions & 2 deletions docs/INSTALL-buildout.rst
Expand Up @@ -50,7 +50,7 @@ steps:

- Download the Zope source distribution from `PyPI`__

__ https://pypi.python.org/pypi/Zope
__ https://pypi.org/project/Zope/

- Bootstrap the buildout

Expand All @@ -62,12 +62,21 @@ On Linux, this can be done as follows::
$ tar xfvz Zope-<Zope version>.tar.gz
$ cd Zope-<Zope version>
$ /path/to/your/python bootstrap.py
$ bin/buildout
$ bin/buildout -n


Creating a Zope instance
::::::::::::::::::::::::

.. attention::

The following steps describe how to install a WSGI based Zope instance.
If you want/have to use ZServer instead of WSGI (Python 2 only!) follow
the documentation `Creating a Zope instance for Zope 2.13`_, as it has not
changed since that version.

.. _`Creating a Zope instance for Zope 2.13` : http://zope.readthedocs.io/en/2.13/INSTALL-buildout.html#creating-a-zope-instance
Once you've installed Zope, you will need to create an "instance
home". This is a directory that contains configuration and data for a
Zope server process. The instance home is created using the
Expand Down
10 changes: 10 additions & 0 deletions docs/INSTALL-virtualenv.rst
Expand Up @@ -36,6 +36,16 @@ version in the URL, replacing 4.0b1 in the example below:
Creating a Zope instance
------------------------

.. attention::

The following steps describe how to install a WSGI based Zope instance.
If you want/have to use ZServer instead of WSGI (Python 2 only!) follow
the documentation `Creating a Zope instance for Zope 2.13`_, as it has not
changed since that version.

.. _`Creating a Zope instance for Zope 2.13` : http://zope.readthedocs.io/en/2.13/INSTALL-virtualenv.html#creating-a-zope-instance
Once you've installed Zope, you will need to create an "instance
home". This is a directory that contains configuration and data for a
Zope server process. The instance home is created using the
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -94,7 +94,7 @@
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
html_style = 'default.css'
html_style = 'alabaster.css'

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down

0 comments on commit 53ce057

Please sign in to comment.