Commit 49497c7a authored by Jim Fulton's avatar Jim Fulton

Reorganization (flatification)

- can ``make html`` from doc directory and get html.

- documentation tests run as part of normal tests.

README.rst needs some love.

Then on to making this work with RTD.
parent f192110f
...@@ -3,6 +3,7 @@ develop = . ...@@ -3,6 +3,7 @@ develop = .
parts = parts =
test test
scripts scripts
sphinx
[versions] [versions]
# Avoid breakage in 4.4.5: # Avoid breakage in 4.4.5:
...@@ -40,3 +41,15 @@ arguments = ('${buildout:directory}/coverage', ...@@ -40,3 +41,15 @@ arguments = ('${buildout:directory}/coverage',
recipe = zc.recipe.egg recipe = zc.recipe.egg
eggs = ${test:eggs} eggs = ${test:eggs}
interpreter = py interpreter = py
[sphinx]
recipe = zc.recipe.egg
eggs =
Sphinx
docutils
ZODB
j1m.sphinxautointerface
j1m.sphinxautozconfig
scripts =
sphinx-build
interpreter = stxpy
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS = SPHINXOPTS =
SPHINXBUILD = bin/sphinx-build SPHINXBUILD = ../bin/sphinx-build
PAPER = PAPER =
# Internal variables. # Internal variables.
......
...@@ -14,7 +14,7 @@ Because ZODB is an object database: ...@@ -14,7 +14,7 @@ Because ZODB is an object database:
- almost no seam between code and database. - almost no seam between code and database.
Check out the :doc:`documentation/tutorial`! Check out the :doc:`tutorial`!
Transactions Transactions
============ ============
...@@ -196,10 +196,10 @@ Learning more ...@@ -196,10 +196,10 @@ Learning more
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
documentation/tutorial tutorial
documentation/guide/index guide/index
documentation/reference/index reference/index
documentation/articles/index articles/index
* `The ZODB Book (in progress) <http://zodb.readthedocs.org/en/latest/>`_ * `The ZODB Book (in progress) <http://zodb.readthedocs.org/en/latest/>`_
......
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
# FOR A PARTICULAR PURPOSE. # FOR A PARTICULAR PURPOSE.
# #
############################################################################## ##############################################################################
from os.path import join
import os import os
import doctest import doctest
import unittest import unittest
...@@ -19,10 +20,9 @@ import manuel.doctest ...@@ -19,10 +20,9 @@ import manuel.doctest
import manuel.testing import manuel.testing
import zope.testing.module import zope.testing.module
from os.path import join import ZODB
def setUp(test): def setUp(test):
import ZODB
test.globs.update( test.globs.update(
ZODB=ZODB, ZODB=ZODB,
) )
...@@ -32,9 +32,11 @@ def tearDown(test): ...@@ -32,9 +32,11 @@ def tearDown(test):
zope.testing.module.tearDown(test) zope.testing.module.tearDown(test)
def test_suite(): def test_suite():
here = os.path.dirname(__file__) base, src = os.path.split(os.path.dirname(os.path.dirname(ZODB.__file__)))
guide = join(here, '..', 'documentation', 'guide') assert src == 'src'
reference = join(here, '..', 'documentation', 'reference') base = join(base, 'doc')
guide = join(base, 'guide')
reference = join(base, 'reference')
return unittest.TestSuite(( return unittest.TestSuite((
manuel.testing.TestSuite( manuel.testing.TestSuite(
......
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