Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Z
Zope
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
Zope
Commits
2b19a9bd
Commit
2b19a9bd
authored
Dec 20, 2014
by
Tres Seaver
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Set up building the docs, and document how.
parent
89d4b184
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
20 additions
and
8 deletions
+20
-8
buildout.cfg
buildout.cfg
+8
-5
docs/INSTALL.rst
docs/INSTALL.rst
+9
-0
docs/_static/_placeholder
docs/_static/_placeholder
+0
-0
docs/operation.rst
docs/operation.rst
+2
-3
versions.cfg
versions.cfg
+1
-0
No files found.
buildout.cfg
View file @
2b19a9bd
...
...
@@ -18,7 +18,7 @@ parts =
zopepy
alltests
allpy
docs
sphinx
checkversions
wsgi
sources-dir = develop
...
...
@@ -86,10 +86,13 @@ interpreter = allpy
scripts = allpy
[docs]
recipe = zc.recipe.egg
eggs = Sphinx
[sphinx]
recipe = collective.recipe.sphinxbuilder
build = ${buildout:directory}/docs/_build
source = ${buildout:directory}/docs
outputs = html
script-name = make-docs
extra-paths = ${buildout:directory}
[checkversions]
recipe = zc.recipe.egg
...
...
docs/INSTALL.rst
View file @
2b19a9bd
...
...
@@ -187,3 +187,12 @@ used to automate this whole process.
After installation, refer to :doc:`operation` for documentation on
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
docs/_static/_placeholder
0 → 100644
View file @
2b19a9bd
docs/operation.rst
View file @
2b19a9bd
...
...
@@ -4,9 +4,8 @@ Configuring and Running Zope
.. highlight:: bash
Whichever method you used to install Zope and create a server instance (see
:doc:`INSTALL` and :doc:`INSTALL-buildout`), the end result is configured
and operated the same way.
After installing Zope and create a server instance (see :doc:`INSTALL`), the
end result is configured and operated as follows.
Configuring Zope
...
...
versions.cfg
View file @
2b19a9bd
...
...
@@ -61,6 +61,7 @@ zope.schema = 4.4.2
zope.traversing = 4.0.0
# Zope2 dependencies
collective.recipe.sphinxbuilder = 0.8.2
mechanize = 0.2.5
repoze.retry = 1.3
repoze.tm2 = 2.0
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment